Skip to content

Latest commit

 

History

History
198 lines (131 loc) · 5.04 KB

GITHUB.md

File metadata and controls

198 lines (131 loc) · 5.04 KB

📦 Configuring Github backend

Note

Every step has screenshots to help you, click on the spoiler to reveal them!

Setting up Github backend may be a little tricky, but if you follow this guide it'll be piece of cake!~ 🍰

1. First steps

Log in or sign up at Github. In this guide, we're assuming you're on desktop 💻

2. Creating repository

Click on plus button at the top, and click on 'New repository'

🖼️ Click here to see screenshots

Screenshot 1 Screenshot 2

Here, enter any desired name (monika-autosaves is a good example), and set it as private

Warning

Your persistent contains all Monika's memories about you — including private info too.
Keep your persistent safe — make your repository private 🛡️

🖼️ Click here to see screenshots

Screenshot 1

We're now done setting up the repository — onto the next step!~

3. Generating API token

Go to your settings — click on your avatar in the top corner, then on 'Settings'

🖼️ Click here to see screenshots

Screenshot 1 Screenshot 2

Look to the left, and scroll all the way to the bottom of the menu — you'll need the section labelled 'Developer settings'

🖼️ Click here to see screenshots

Screenshot 1

Now, click on 'Personal access tokens' section to unfold it, then on 'Fine-grained tokens'

🖼️ Click here to see screenshots

Screenshot 1 Screenshot 2

Click on 'Generate new token' button

Note

You may be asked to enter your password or authorize with 2FA here — do so if asked

🖼️ Click here to see screenshots

Screenshot 1

Type anything you like in the 'Token name' field — it only serves as a label for you; next up, select 'No expiration' under 'Expiration' field — so that you won't have to renew this API token again in future

🖼️ Click here to see screenshots

Screenshot 1

Further on, scroll down to 'Repository access' section; here, click on 'Only select repositories', and select your previously created repository from the list

🖼️ Click here to see screenshots

Screenshot 1 Screenshot 2

Then scroll down to 'Permissions' section; click on it to unfold, find 'Contents' section and set it to 'Read and write'

🖼️ Click here to see screenshots

Screenshot 1 Screenshot 2 Screenshot 3

Almost there — scroll until you see 'Generate token' button and press it, then copy the token using 'copy' button

🖼️ Click here to see screenshots

Screenshot 1 Screenshot 2

Github stuff is behind us now — let's set up Autosave submod in game 🎉

4. Setting up the submod

Open Submods menu in settings, and click on 'API Keys' section on the left

🖼️ Click here to see screenshots

Screenshot 1

Find '[Autosave] Github API token' field, and click 'Paste'

🖼️ Click here to see screenshots

Screenshot 1 Screenshot 1

Open 'Submods' section on the left, and find 'Autosave' submod in the list — then, click 'Select repository' and select your repository from earlier steps

🖼️ Click here to see screenshots

Screenshot 1 Screenshot 2

You can check that it works by clicking 'Force save' and saving your persistent.

🖼️ Click here to see screenshots

Screenshot 1 Screenshot 2

You're all set! 🥳