mirror of
https://github.com/yairm210/Unciv.git
synced 2025-07-10 15:59:33 +07:00
Added documentation for autoupdates
This commit is contained in:
@ -10,4 +10,4 @@ nav:
|
|||||||
- uniques.md
|
- uniques.md
|
||||||
- Type-checking.md
|
- Type-checking.md
|
||||||
- Scenarios.md
|
- Scenarios.md
|
||||||
- CI-automation.md
|
- Autoupdates.md
|
||||||
|
20
docs/Modders/Autoupdates.md
Normal file
20
docs/Modders/Autoupdates.md
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
# Autoupdates
|
||||||
|
|
||||||
|
Unciv contains built-in capabilities for packing images and autoupdating uniques.
|
||||||
|
|
||||||
|
You can automate these updates by adding a GitHub Actions workflow to your repository.
|
||||||
|
|
||||||
|
- In your Github page go to "actions" tab
|
||||||
|
- Suggested for this repo > Simple workflow > "Configure"
|
||||||
|
- Copy the text of [this file](https://github.com/yairm210/Unciv-IV-mod/blob/master/.github/workflows/autoupdate.yml) ("copy raw file") to the new file in your repo
|
||||||
|
- Change the file name to "autoupdate.yml" at the top
|
||||||
|
- "Commit changes" (green button, top-right) > "Commit changes"
|
||||||
|
|
||||||
|
On every commit, and once per day, it will:
|
||||||
|
|
||||||
|
- Try to shrink PNGs (this is lossless, the pixel data remains the same but the file takes less space)
|
||||||
|
- Try to autoupdate deprecated uniques
|
||||||
|
|
||||||
|
If there are changes, this will create a PR to your repo - [here's an example](https://github.com/yairm210/Unciv-IV-mod/pull/31) - which you can choose to accept
|
||||||
|
|
||||||
|
If you see that the autoupdate isn't 100% - in which case talk to me and we'll sort it out 🙂
|
@ -1,7 +0,0 @@
|
|||||||
# AI automation
|
|
||||||
|
|
||||||
Unciv contains built-in capabilities for packing images and autoupdating uniques.
|
|
||||||
You can use Unciv as a command-line tool by running it with the command
|
|
||||||
|
|
||||||
`java -jar <folder location>/Unciv.jar mod-ci`
|
|
||||||
|
|
Reference in New Issue
Block a user