mirror of
https://gitea.tendokyu.moe/Dniel97/artemis.git
synced 2026-09-28 21:07:55 +03:00
Fix Windows documentation (#23)
Hello, I installed artemis on my windows pc and I had a few difficulties, and later noticed I was being distracted and cloned the wrong repository, this should fix it to make it easier for future users. Evaluate if you want to apply the same changes to linux/docekr files or tell me if you're not changing them for a specific reason - Updated python and mariadb links and versions - Updated repository link to clone (removed checkout mention as idac is the default branch) - Fixed documentation links Co-authored-by: Scrappy <mikelerogeratro@yahoo.it> Reviewed-on: https://gitea.tendokyu.moe/Dniel97/artemis/pulls/23 Reviewed-by: Dniel97 <dniel97@noreply.gitea.tendokyu.moe> Co-authored-by: ScrappyCocco <scrappycocco@noreply.gitea.tendokyu.moe> Co-committed-by: ScrappyCocco <scrappycocco@noreply.gitea.tendokyu.moe>
This commit is contained in:
committed by
Dniel97
co-authored by
Scrappy
parent
0a6483464e
commit
cbb117d248
@@ -4,14 +4,14 @@ This guide assumes a fresh install of Windows 10. Please be aware that due to th
|
||||
## Install prerequisites
|
||||
### Python
|
||||
- Python versions from 3.8 to 3.11 work with ARTEMiS. We recommend 3.11.
|
||||
- https://www.python.org/ftp/python/3.11.7/python-3.11.7-amd64.exe
|
||||
- https://www.python.org/ftp/python/3.11.9/python-3.11.9-amd64.exe
|
||||
- Install using whichever options best suit your environment, making sure that the Python executable is on path, such that you can open CMD, type `python --version` and see the version of Python you have installed.
|
||||
- If you already have a working version of Python installed, skip this step.
|
||||
|
||||
### MariaDB
|
||||
- It is always recommended to use MariaDB over MySQL because Oracle is a terrible company.
|
||||
- While the latest release of v10 is recommended, as it is an LTS release, v11 should work fine.
|
||||
- https://ftp.osuosl.org/pub/mariadb//mariadb-10.11.6/winx64-packages/mariadb-10.11.6-winx64.msi
|
||||
- https://mariadb.org/download/?t=mariadb&p=mariadb&r=10.11.18
|
||||
- REMEMBER YOUR ROOT PASSWORD SO YOU CAN LOG IN IN FUTURE STEPS.
|
||||
|
||||
### Git
|
||||
@@ -25,6 +25,7 @@ This guide assumes a fresh install of Windows 10. Please be aware that due to th
|
||||
- https://dbeaver.io/download/
|
||||
|
||||
## Obtain ARTEMiS
|
||||
- Pay attention if you're in a fork to use the correct link!
|
||||
### Via git (recommended)
|
||||
- `git clone https://gitea.tendokyu.moe/Hay1tsme/artemis.git` via cmd in whatever folder you want to install ARTEMiS.
|
||||
- You can switch to the develop branch for latest changes via `git checkout develop`.
|
||||
@@ -46,7 +47,7 @@ GRANT Alter,Create,Delete,Drop,Index,Insert,References,Select,Update ON aime.* T
|
||||
|
||||
## Create a venv
|
||||
- Python virtual environments are a good way to manage packages and make dealing with python and pip easier.
|
||||
- `python -m pip venv venv`
|
||||
- `python -m venv venv`
|
||||
- `venv\Scripts\activate.bat` to activate the venv whenever you need to interact with ARTEMiS.
|
||||
- All the rest of the steps assume your venv is activated.
|
||||
|
||||
@@ -60,11 +61,11 @@ GRANT Alter,Create,Delete,Drop,Index,Insert,References,Select,Update ON aime.* T
|
||||
- Put in the aimedb key (YOU DO NOT GENERATE THIS KEY, FIND IT SOMEWHERE).
|
||||
- Set your hostname to be whatever hostname or IP address games can reach your server at (many games reject localhost and 127.0.0.1).
|
||||
- Optional: generate base64-encoded secrets for aimedb and frontend using something like `openssl rand -base64 64`. It is advised to make all secrets different.
|
||||
- See [config.md](docs/config.md) for a full list of options.
|
||||
- See [config.md](config.md) for a full list of options.
|
||||
- edit `idz.yaml`
|
||||
- If you don't plan on anyone using your server to play Initial D Zero, it is best to disable it to cut down on console spam on boot.
|
||||
- Edit other game yamls
|
||||
- Add keys, set hostnames, ports, etc. Specific settings will depend on the game. See [game_specific_info](docs/game_specific_info.md).
|
||||
- Add keys, set hostnames, ports, etc. Specific settings will depend on the game. See [game_specific_info](game_specific_info.md).
|
||||
|
||||
## Create Database Tables
|
||||
- `python dbutils.py create`
|
||||
|
||||
Reference in New Issue
Block a user