spt/Website
spt/Website
2
2
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ran through a spell check

Browse Source
This commit is contained in:
Atomos821 2020-11-28 10:49:54 +01:00
parent 6db58fa2e5
commit 0f0fcb618d
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/md/tutorials/tut_0/tut0_1.md
View File

@ -1,6 +1,6 @@
# Getting started # Getting started
You will begin by creating a fresh profile using the SPT-AKI launcher. By following this tutorial, you'll prepare everything needed to proceed with the next steps. You will begin by creating a fresh profile using the SPT-AKI launcher. At the end of this tutorial, you will have prepared everything needed to proceed with the next steps.
In this part you will be doing the following: In this part you will be doing the following:
@ -10,7 +10,7 @@ In this part you will be doing the following:
## Legend ## Legend
The table below is a set of "expressions" that will be used to avoid writing informations that might not apply to your use case, such as the path to your SPT-AKI installation, or a randomly generated value. The table below is a set of "expressions" that will be used to avoid writing information that might not apply to your use case, such as the path to your SPT-AKI installation, or a randomly generated value.
Expression | What | Example Expression | What | Example
--------------|-----------------------------|-------- --------------|-----------------------------|--------
@ -19,12 +19,12 @@ Expression | What | Example
## Creating a new profile ## Creating a new profile
You want a way to fool around in SPT-AKI but without also ruining the fun of having a character evolving normally. As such creating a new dedicated profile is probably the best way of achiving this goal. You want a way to fool around in SPT-AKI, but without also ruining the fun of having a character evolving normally. As such, creating a new dedicated profile is probably the best way of achieving this goal.
To create a new profile: To create a new profile:
1. Start SPT-AKI's server by going into `%game%\server\` and double clicking on the server executable. 1. Start SPT-AKI's server by going into `%game%server` and double-clicking on the server executable.
2. Start SPT-AKI's launcher by going into `%game%\` and double clicking on the launcher executable. 2. Start SPT-AKI's launcher by going into `%game%` and double-clicking on the launcher executable.
3. Create a new profile through the launcher. 3. Create a new profile through the launcher.
![logging out of account 1/2](../assets/img/spt-aki/tutorials/tut_0/002.png) ![logging out of account 1/2](../assets/img/spt-aki/tutorials/tut_0/002.png)
@ -33,10 +33,10 @@ To create a new profile:
![account ready](../assets/img/spt-aki/tutorials/tut_0/005.png) ![account ready](../assets/img/spt-aki/tutorials/tut_0/005.png)
> **Note**\ > **Note**\
> At this point the profile file is already created but the file is mostly empty. The profile still need to go through the onboarding process in the game, that will populate the file much more. > At this point the profile file is already created, but the file is mostly empty. The profile still need to go through the on-boarding process in the game that will populate the file much more.
4. Starts the game. 4. Starts the game.
5. Go through the onboarding and choose your language, nickname and faction. 5. Go through the on-boarding and choose your language, nickname and faction.
![main menu](../assets/img/spt-aki/tutorials/tut_0/006.png) ![main menu](../assets/img/spt-aki/tutorials/tut_0/006.png)
@ -48,11 +48,11 @@ To create a new profile:
## Identifying a profile ## Identifying a profile
Now that you have created a new profile, you will need to identify it in the server files. Profiles are stored with a unique random ID and as such it may seem hard to know where and which file to look for. Now that you have created a new profile, you will need to identify it in the server files. Profiles are stored with a unique random ID. As such, it may seem hard to know where and which file to look for.
To find a specific profile: To find a specific profile:
1. Go into `%game%\Server\user\profiles\`. 1. Go into `%game%Serveruserprofiles`.
2. One by one, open a profile file in a code editor and look for the `email` and/or `Nickname` properties. 2. One by one, open a profile file in a code editor and look for the `email` and/or `Nickname` properties.
![profile file content](../assets/img/spt-aki/tutorials/tut_0/007.png) ![profile file content](../assets/img/spt-aki/tutorials/tut_0/007.png)
@ -60,17 +60,17 @@ To find a specific profile:
After a bit of research you should have now identified which profile you want to use and can proceed with the next step. After a bit of research you should have now identified which profile you want to use and can proceed with the next step.
> **Alternative "quick" way**\ > **Alternative "quick" way**\
> You can quickly identify a profile ID by checking for which profile are the request sent to the server. The ID will be listed at the start of each server request in the server window. Once you've identified the profile ID, you can directly go look for the profile file with the same name in `%game%\Server\user\profiles\`. > You can quickly identify a profile ID by checking for which profile are the request sent to the server. The ID will be listed at the start of each server's request in the server window. Once you've identified the profile ID, you can directly go look for the profile file with the same name in `%game%\Server\user\profiles\`.
> ![profile file content](../assets/img/spt-aki/tutorials/tut_0/008.png) > ![profile file content](../assets/img/spt-aki/tutorials/tut_0/008.png)
## Making a backup ## Making a backup
> **Note**\ > **Note**\
> This section talk about a good practices that could save you some time in case of a error or a corrupted profile. If you want to just move on with the next steps you can directly go to the [next page](./#tutorials/tut_0/tut0_2.md). > This section talks about a good practices that could save you some time in case of an error or a corrupted profile. If you want to just move on with the next steps you can directly go to the [next page](./#tutorials/tut_0/tut0_2.md).
Making a profile backup will allow you to not loose your work if you make a mistake while editing your profile. It's also very usefull in case of profile corruption due to a server error and/or improper profile save. Making a profile backup will allow you to not lose your work if you make a mistake while editing your profile. It's also very useful in case of profile corruption due to a server error and/or improper profile save.
To backup a profile, it's recommanded to create a new folder outside of any of the folders used by the server to write data (like `%game%\Server\user\profiles\`) and to create a `backups` folder at the root of the server directory. To backup a profile, it's recommended to create a new folder out of any of the folders used by the server to write data (like `%game%\Server\user\profiles\`) and to create a 'backups' folder at the root of the server directory.
This way, if you ever wanted to roll back and/or restore a corrupted profile, you would just need to go get a previous version of it and copy/paste it over the faulty file. This way, if you ever wanted to roll back and/or restore a corrupted profile, you would just need to go get a previous version of it and copy/paste it over the faulty file.