Skip to content

README.md

Latest commit

 

History

History
112 lines (85 loc) · 3.15 KB

README.md

File metadata and controls

112 lines (85 loc) · 3.15 KB
Raw

ClearFiveM

ClearFiveM is a tool to keep your FiveM installation clean and optimized. 🚀

✨ Features

  • 🧹 Cache Cleaning
  • 📝 Logs and Crashes Cleaning
  • 🔒 Digital Entitlements Cleaning
  • ⏳ Temporary Files Cleaning
  • 🗑️ fivem.cfg File Deletion

🛠️ Requirements

📥 Installation and Usage

  1. Download and Unzip

    • 📥 Download the zip file for your operating system from the releases page.
    • 📂 Unzip the downloaded file to a desired location on your computer.

  2. Run the Application

    • 💻 Navigate to the unzipped folder.
    • 🖱️ Double-click on ClearFiveM.exe to start the application.

  3. Use the Tool

    • Upon launching, you will see a menu with options: 
      1. Clean Cache
2. Clean Logs and Crashes
3. Clean Digital Entitlements
4. Clean Temporary Files
5. Delete CitizenFX File
6. Exit
    • 🔢 Select the desired option by typing the corresponding number and pressing Enter.

  4. Follow On-Screen Instructions

    • 📋 Follow the instructions displayed in the console to complete the cleaning process.

🛠️ Building from Source

  1. Clone the Repository

    • Open your terminal or command prompt.
    • Run the following command to clone the repository: 
      gh repo clone Imperio-Company/ClearFiveM
    • Navigate to the cloned directory: 
      cd ClearFiveM

  2. Open the Project in Visual Studio

    • Launch Visual Studio.
    • Select File > Open > Project/Solution.
    • Navigate to the cloned repository folder and open ClearFiveM.sln.

  3. Restore NuGet Packages

    • In Visual Studio, go to Tools > NuGet Package Manager > Manage NuGet Packages for Solution.
    • Click on Restore to restore the necessary packages.

  4. Build the Project

    • In Visual Studio, select Build > Build Solution or press Ctrl+Shift+B.

  5. Run the Application

    • Press F5 to run the application.

🤝 Contributing

  1. Fork the Repository

    • Click the Fork button at the top right of the repository page.

  2. Create a New Branch

    • Open your terminal or command prompt.
    • Run the following commands: 
      git checkout -b feature-branch

  3. Make Your Changes

    • Edit the code as needed.

  4. Commit Your Changes

    • Stage your changes: 
      git add .
    • Commit your changes: 
      git commit -m "Description of the changes"

  5. Push to Your Fork

    • Push your changes: 
      git push origin feature-branch

  6. Create a Pull Request

    • Go to the repository on GitHub.
    • Click on Compare & pull request.
    • Submit your pull request for review.

📄 License

This project is licensed under the MIT License. See the LICENSE file for more details.

🛠️ Support

If you encounter any issues or have questions, please open an issue on GitHub or contact us at imperioorp@gmail.com.