forked from Rainson12/FactorioSaveGameEnableAchievements
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
576d34d
commit 316b644
Showing
1 changed file
with
91 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
# 🚀 FactorioSaveGameEnableAchievements | ||
|
||
This project is a console application that modifies Factorio save files to re-enable achievements disabled by commands or map editor. | ||
|
||
--- | ||
|
||
## ✨ Features | ||
- 🧐 Automatically extracts save files. | ||
- 🔍 Modifies data to re-enable achievements. | ||
- 🗂 Backs up the original save file. | ||
- 📦 Recompresses the save file with a versioned zip. | ||
|
||
--- | ||
|
||
## 🗃️ Requirements | ||
- .NET 8.0 SDK | ||
- Visual Studio or compatible C# IDE | ||
- Factorio save files (.zip format) | ||
|
||
--- | ||
|
||
## 🧑💻 How to Compile and Run | ||
### 1. Clone the Repository | ||
```bash | ||
git clone https://github.com/louanfontenele/FactorioSaveGameEnableAchievements | ||
cd FactorioSaveGameEnableAchievements | ||
``` | ||
|
||
### 2. Build the Project | ||
```bash | ||
dotnet build | ||
``` | ||
|
||
### 3. Run the Program | ||
```bash | ||
dotnet run | ||
``` | ||
|
||
Alternatively, open the solution file in Visual Studio. | ||
|
||
--- | ||
|
||
## 🕹️ How to Use | ||
1. Run the application. | ||
2. Enter the path to the save file (e.g., `%appdata%\Factorio\saves\mysave.zip`). | ||
3. The program modifies the save and creates a backup with `.bak`. | ||
|
||
--- | ||
|
||
## 📊 Automated Release Process | ||
- **Changelog Generation**: A changelog is automatically created with each release. | ||
- **Versioning**: Semantic versioning is used (). | ||
- **Release Output**: The zip follows the format: | ||
``` | ||
FactorioSaveGameEnableAchievements-<version>.zip | ||
``` | ||
|
||
--- | ||
|
||
### 🔧 Commit Format (For Changelog) | ||
Use the following format to categorize commits: | ||
|
||
```bash | ||
git commit -m "Feature: Add new mechanic" | ||
git commit -m "Fix: Resolve save crash" | ||
git commit -m "Update: Improve save structure" | ||
git commit -m "Remove: Remove deprecated feature" | ||
``` | ||
|
||
--- | ||
|
||
## 📦 Full Changelog | ||
Check the **[Releases Section](https://github.com/louanfontenele/FactorioSaveGameEnableAchievements/releases)**. | ||
Compare full changes **[here](https://github.com/louanfontenele/FactorioSaveGameEnableAchievements/compare)**. | ||
|
||
--- | ||
|
||
## 📊 Status | ||
[](https://github.com/louanfontenele/FactorioSaveGameEnableAchievements/actions/workflows/release-windows-dotnet.yml) | ||
|
||
--- | ||
|
||
## 📝 Notes | ||
- Ensure the save file is not in use by Factorio. | ||
- This tool modifies saves that disable achievements. | ||
|
||
--- | ||
|
||
## 📩 Contact | ||
For questions, open an **[issue](https://github.com/louanfontenele/FactorioSaveGameEnableAchievements/issues)** or contact directly via GitHub. | ||
|