# modmapper

![healthchecks.io](https://healthchecks.io/badge/2b775ee7-2b5e-45b4-9060-094c91/Qu0gXX0s.svg)

Downloads mods from nexus, parses the plugins inside, and saves data to a postgres database.

## Development Install

1. Install and run postgres (v15 or later).
2. Create postgres user and database (and add uuid extension while you're there
   ):

```
createuser modmapper
createdb modmapper
sudo -u postgres -i psql
postgres=# ALTER DATABASE modmapper OWNER TO modmapper;
postgres=# ALTER USER modmapper CREATEDB;
\password modmapper

# Or, on Windows in PowerShell:

& 'C:\Program Files\PostgreSQL\13\bin\createuser.exe' -U postgres modmapper
& 'C:\Program Files\PostgreSQL\13\bin\createdb.exe' -U postgres modmapper
& 'C:\Program Files\PostgreSQL\13\bin\psql.exe' -U postgres
postgres=# ALTER DATABASE modmapper OWNER TO modmapper;
postgres=# ALTER USER modmapper CREATEDB;
\password modmapper
```

3. Save password somewhere safe and then and add a `.env` file to the project
   directory with the contents:

```
DATABASE_URL=postgresql://modmapper:<password>@localhost/modmapper
RUST_LOG=mod_mapper=debug
```

4. Install
   [`sqlx_cli`](https://github.com/launchbadge/sqlx/tree/master/sqlx-cli) with
   `cargo install sqlx-cli --no-default-features --features postgres`
5. Run `sqlx migrate run` which will run all the database migrations.
6. Get your personal Nexus API token from your profile settings and add it to
   the `.env` file:

```
NEXUS_API_KEY=...
```

7. Build the release binary by running `cargo build --release`.
8. Run `./target/release/mod-mapper --backfill-is-base-game` to pre-populate the
   database with worlds and cells from the base game's Skyrim.esm. (This is so
   that the base game cells can later be differentiated from cells in plugins that
   also happen to be named Skyrim.esm and have cells that reference a world with
   the same form ID as Tamriel.)
9. See `./target/release/mod-mapper -h` for further commands or run `./scripts/update.sh` to start populating the database with scraped mods and dumping the data to JSON files.

## Sync and Backup Setup

`scripts/sync.sh` and `scripts/backup.sh` both utilize [`rclone`](https://rclone.org) to transfer files that are generated on the machine running modmapper to separate servers for file storage.

For these scripts to run successfully you will need to install rclone and setup a remote for `sync.sh` (the "static server") and a remote for `backup.sh` (the "backup server"). Remotes can be created with the `rclone config` command. Then, make sure these variables are defined in the `.env` file corresponding to the remote names and buckets (or folders) within that remote you created:

- `STATIC_SERVER_REMOTE`
- `STATIC_SERVER_CELLS_BUCKET`
- `STATIC_SERVER_MODS_BUCKET`
- `STATIC_SERVER_PLUGINS_BUCKET`
- `STATIC_SERVER_FILES_BUCKET`
- `BACKUP_SERVER_REMOTE`
- `BACKUP_SERVER_BUCKET`

## Healthchecks.io Monitoring

The scripts are monitored via [healthchecks.io](https://healthchecks.io). It is free to set up, create an account and add a new check for each script with these slugs:

- `modmapper-update`
- `modmapper-sync`
- `modmapper-backup`

Then add the project's [ping key which you can generate in the settings](https://healthchecks.io/docs/slug_urls/) to the `.env` file under `HEALTHCHECKS_PING_KEY`.

## Crontab Setup

The scripts can be run on a schedule via cron. To edit the crontab for the current user run `crontab -e` and add these lines to run the scripts at the specified intervals:

```# Run modmapper update script every day at 2 am
0 2 * * * cd /path/to/modmapper && ./scripts/update.sh && ./scripts/sync.sh && ./scripts/backup.sh
```