Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add synced Wiki #24

Merged
merged 3 commits into from
Jan 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/workflows/sync-wiki.yml
Original file line number Diff line number Diff line change
@@ -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 }}"
1 change: 1 addition & 0 deletions wiki/Home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Welcome to the ServerUtilities wiki!
11 changes: 11 additions & 0 deletions wiki/Quick-Install.md
Original file line number Diff line number Diff line change
@@ -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.