diff --git a/.github/workflows/sync-wiki.yml b/.github/workflows/sync-wiki.yml new file mode 100644 index 000000000..3dd44277c --- /dev/null +++ b/.github/workflows/sync-wiki.yml @@ -0,0 +1,19 @@ +on: + push: + branches: + - master +name: Wiki Sync +jobs: + update-wiki: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Sync Wiki + uses: GTNewHorizons/ghaction-wiki-sync@master + with: + username: "GitHub-GTNH-Actions" + access_token: ${{ secrets.GITHUB_TOKEN }} + ignore_safe_warnings: true + commit_username: "GitHub GTNH Actions" + commit_email: "<>" + commit_message: "automatic wiki sync: ${{ github.event.commits[0].message }}" diff --git a/wiki/Home.md b/wiki/Home.md new file mode 100644 index 000000000..f752120c0 --- /dev/null +++ b/wiki/Home.md @@ -0,0 +1 @@ +Welcome to the ServerUtilities wiki! diff --git a/wiki/Quick-Install.md b/wiki/Quick-Install.md new file mode 100644 index 000000000..09e156839 --- /dev/null +++ b/wiki/Quick-Install.md @@ -0,0 +1,11 @@ +Download the latest JAR from [releases](https://github.com/GTNewHorizons/ServerUtilities/releases) - you want the one named ServerUtilities-number.jar, not the `dev` or `sources`. Place it in the `/mods` folder on your server AND client (if single player, on client only). + +Once loaded, you will find new UI options in your inventory screen: + +![ServerUtilities GUI](claimed_chunks.png) + +For single player, loading chunks is the most important, and you can click that icon and then shift-click (and drag) to designate chunks to load. Right click to unload and unclaim. + +The ServerUtilities configuration files are found in `.minecraft/serverutilities` and it will migrate from FTBU for you. The most likely thing you want to change is found in `.minecraft/serverutilties/server/ranks.txt` where you can control how many chunks can be loaded. `.minecraft/serverutilities/serverutlities.cfg` is where you can disable backups if you have another backup solution. + +For server admins, there is much more that ServerUtilities can do, refer to the FTBU documentation for now.