develop#setup-guides

Running ARTEMiS on the same PC as your game.

stop

THIS GUIDE IS ALREADY OUT OF DATE, USE AT YOUR OWN RISK.

Simple setup for local use only, with screenshots for extra easy. Tested on a fresh Windows 10 install.
Work in Progress, more screenshots/instructions will be added when I get around to it.

MAKE SURE THE GAME YOU ARE TRYING TO PLAY IS SUPPORTED BY ARTEMIS.
Supported games are listed here. https://gitea.tendokyu.moe/Hay1tsme/artemis/src/branch/develop

Open File Explorer and enable View File name extensions

view extensions

Table of Contents

Python
MySQL
ARTEMiS
Importing your game data
segatools config
Running ARTEMiS

Python

Download Python 3.9 installer (python-3.9.13-amd64.exe). https://www.python.org/ftp/python/3.9.13/python-3.9.13-amd64.exe

Run the downloaded python-3.9.13-amd64.exe, tick the Add Python 3.9 to PATH box, and then click Install Now. If the User Account Control admin prompt comes up, click yes.

python

When the window says Setup was successful, click on the Close button.

MySQL

Download MySQL 8.0 Server installer (mysql-installer-community-8.0.34.0.msi). https://dev.mysql.com/get/Downloads/MySQLInstaller/mysql-installer-community-8.0.34.0.msi

Run the downloaded mysql-installer-community-8.0.34.0.msi, select Server only, click Next.

mysql

If the Check Requirements page identifies any other required files, click Execute and run through any installers that pop up, using the default options.

mysql

Once this is complete, press Next.

Confirm MySQL Server 8.0.xx is listed to be installed, then click Execute.

mysql

When the install is complete, you will have a green tick next to the MySQL Server logo. click Next.

mysql

On the Product Configuration page, click Next again. On the Type and Networking page, make sure Config Type: is set to Development Computer, leave all other settings as they are and click Next.

mysql

On the Authentication Method page, select Use Legacy Authentication Method, and click Next.

mysql

On the Accounts and Roles page, enter a Root password you will remember, and click Next. On the Windows Service page, leave everything as default and click Next. On Server File Permissions, leave on the default option and click Next. On the Apply Configuration page, click Execute. Wait for each line to have a green tick, then click Finish.

mysql

On the Product Configuration page, click Next, then click Finish.

Open your Start Menu and find MySQL 8.0 Command Line Client. Open it. When prompted for a password, enter the Root password you created earlier.

mysql

The next 5 lines should be copy and pasted into the MySQL Command Line Client window, 1 line at a time. For the first line, you should change <Enter Password Here> to an actual password you will remember. For this guide I will be using aime for both the username and password for simplicity.

CREATE USER 'aime'@'localhost' IDENTIFIED BY '<Enter Password Here>'; CREATE DATABASE aime; GRANT Alter,Create,Delete,Drop,Index,Insert,References,Select,Update ON aime.* TO 'aime'@'localhost'; FLUSH PRIVILEGES; exit;

After the last line, exit; the window will close itself. This is normal.

mysql

ARTEMiS

Download the latest version of the Develop branch of ARTEMiS. https://gitea.tendokyu.moe/Hay1tsme/artemis/archive/develop.zip Extract the artemis folder from the zip file to somewhere on your computer. For this guide I put it in the root of the C: drive. Open your artemis folder and rename example_config to config.

artemis

Open the config folder, right click on core.yaml, click on Open With, click on More apps, select Notepad and click OK. artemis

Under the server: section, change the listen address from "127.0.0.1" to "0.0.0.0".
Change is_develop from True to False.
Under the title: section, modify the reboot_start_time and reboot_end_time lines if you want to change the maintenance window.
Under the database: section, change the password from "aime" to the password you set in the first line you copied into the MySQL Command Line Client. If you set the password to "aime" like I did, leave it as it is.
Scroll down to the aimedb: section and set the key to "Copyright(C)SEGA"

artemis artemis

Click File, Save, and then close Notepad.

Go back to your artemis folder, click in the address bar and type cmd, then press enter. This will open a command prompt window in this folder.

artemis

Copy and paste the following command into the Command Prompt window. Wait for the command to complete.
pip install -r requirements.txt

artemis

Copy and paste the following command into the Command Prompt window. Wait for the command to complete.
python dbutils.py create

artemis

Type the following command to check that ARTEMiS is working as intended.
python index.py
If the Windows Defender Firewall Alert pops up, click Allow Access. Check the output in the Command Prompt window and make sure there are no errors.

artemis

If no errors are showing and ARTEMiS shows as Ready, you are now ready to import your game data.
Hold down ctrl and press C to stop ARTEMiS running for the time being.

Importing your game data

The import instructions for each game supported by ARTEMiS is listed on the following page.
https://gitea.tendokyu.moe/Hay1tsme/artemis/src/branch/develop/docs/game_specific_info.md

Find the game you wish to import data for in the Table of contents and click on it to be taken to that games section.
Find the suggested command, starting with python read.py, copy it somewhere you can edit it, and change any part between the <Pointy Brackets> with the correct value for your copy of the game from the table provided.
Replace the /path/to/game/folder and /path/to/option/folder with the location of the game on your PC. The binfolder can vary slightly from game to game. For Chunithm, this should be the folder that contains A000. For MaiMai and Ongeki, this will be your StreamingAssets folder.
Paste the command into the Command Prompt window used during the previous steps. If you closed this window, go to the folder where your ARTEMiS files are, click in the address bar, type cmd, and hit enter.
ARTEMiS will start importing your games data into its database, this may take a while. It will tell you when it's done and leave you at a blank prompt once again.

As an example, if you were to import Chunithm Sun, installed at C:\ChunithmSUN\, with the option folder inside the bin folder, the command shown on the page
python read.py --game SDBT --version <version ID> --binfolder /path/to/game/folder --optfolder /path/to/game/option/folder
would become
python read.py --game SDBT --version 13 --binfolder C:\ChunithmSUN\App\data --optfolder C:\ChunithmSUN\App\bin\option

If your game folder has spaces in it, such as C:\Chunithm SUN 2.10\, you will need to put the directory locations in quotation marks.
python read.py --game SDBT --version 13 --binfolder "C:\Chunithm SUN 2.10\App\data" --optfolder "C:\Chunithm SUN 2.10\App\bin\option"

Most games will have further configuration that is set in one of the .yaml files in your artemis\config\ folder. The game specific info page will tell you the options and the name of the .yaml file you will need to edit for each game, though most are self explanatory.

For Chunithm SUN you will need to set the rom and data version in chuni.yaml. If you are using the latest public files, under version: 13:, set rom: to 2.10.01 and data: to 2.10.13.

I will probably end up adding screenshots of the import process for at least one or two games in the future

segatools config

To connect your game to ARTEMiS, you will need to find your local IP address. You can do this by opening a command prompt, typing ipconfig, and finding your IPv4 Address.

segatools

In the segatools.ini for your game, you should enter this IP address under the [dns] section.

-> segatools

Running ARTEMiS

ARTEMiS will need to be running on your PC before you launch your game.
Open the folder containing your ARTEMiS files, click in the address bar, type cmd, and hit enter.
In the Command Prompt window that opens, type python index.py.
You will need to leave this window running while playing your game.

running

In the future I will add steps for creating a batch file to run ARTEMiS from a desktop/start menu shortcut, and possibly steps for having ARTEMiS run at startup as a service.