5UP3RB/actaeon
1
0
Fork 0
forked from sk1982/actaeon
Code Pull Requests Activity

some readme changes

Browse Source
This commit is contained in:
sk1982 2024-04-07 22:13:10 -04:00
parent 890ca6dc2d
commit 169ea3c566
2 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -27,7 +27,8 @@ Make sure you have [created tables](#creating-database-tables) and ran [database
2. Run `docker compose up` (or `docker compose up -d` to detach the output) 2. Run `docker compose up` (or `docker compose up -d` to detach the output)
### Running without Docker ### Running without Docker
1. Run `npm run start` 1. Set any [runtime environment variables](#runtime-variables) in `.env.local` that you have not set already.
2. Run `npm run start`
## Initial Promotion to Owner ## Initial Promotion to Owner
In order to access all features of Actaeon, you need to have owner permissions. This can be done by setting the `permissions` column of your user inside the `aime_user` table to `255`, or by running the server with [`ACTAEON_OWNER_ID`](#runtime-variables) set to your user id. Once one user is owner, they can promote other users to owner through the Actaeon web interface. You can find out your user id by inspecting your ARTEMiS logs: In order to access all features of Actaeon, you need to have owner permissions. This can be done by setting the `permissions` column of your user inside the `aime_user` table to `255`, or by running the server with [`ACTAEON_OWNER_ID`](#runtime-variables) set to your user id. Once one user is owner, they can promote other users to owner through the Actaeon web interface. You can find out your user id by inspecting your ARTEMiS logs:
@ -40,7 +41,7 @@ Aimedb | INFO | access_code ******************** -> user_id 10000
Environment variables can be added through `.env.local` or through the environment. At bare minimum, you will need to set the [`NEXT_PUBLIC_*_EXTENSION`](#build-time-variables) variables to the corresponding file extensions generated by the [`asset-extract.py` script](scripts/README.md#asset-configs), along with the [`DATABASE_URL` and `NEXTAUTH_SECRET`](#runtime-variables) variables. Environment variables can be added through `.env.local` or through the environment. At bare minimum, you will need to set the [`NEXT_PUBLIC_*_EXTENSION`](#build-time-variables) variables to the corresponding file extensions generated by the [`asset-extract.py` script](scripts/README.md#asset-configs), along with the [`DATABASE_URL` and `NEXTAUTH_SECRET`](#runtime-variables) variables.
### Build-time Variables ### Build-time Variables
These variables can only be set at build time: before running `npm run build` or before building the docker image. These variables can only be set in `.env.local` at build time: before running `npm run build` or before building the docker image.
| Variable | Description | Examples | Required | | Variable | Description | Examples | Required |
|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|----------| |--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|----------|

2
scripts/README.md
View File

@ -17,7 +17,7 @@ You must specify the path to these executables inside `paths.yaml` if they are n
2. [`vgmstream-cli`](https://vgmstream.org/) 2. [`vgmstream-cli`](https://vgmstream.org/)
### Asset Configs ### Asset Configs
You can customize the file extension and ffmpeg arguments of generated files through an `assets.yaml` file. Some exiting assets configs have already been provided. Read the comment in the first line of the file to decide which one you want to use. You can customize the file extension and ffmpeg arguments of generated files through an `assets.yaml` file. Some existing assets configs have already been provided. Read the comment in the first line of the file to decide which one you want to use.
### Options ### Options
These options must be specified before the `game` argument These options must be specified before the `game` argument