Go to file

Tyler Hallada a677325c4d Prevent overwriting of base game cells is_base_game value

This fixes a bug that was causing cell data to not get written since
November 9th, 2023. When batch inserting cells while processing plugins,
I allowed overwriting cells that had `is_base_game = true`. Since I
always set `is_base_game = false` for cell upserts from plugins, this
was causing the base game cells to revert to `is_base_game = false`. All
it took was one mod to bundle `Skyrim.esm` for this to happen.

This broke writing cell data since `get_cell_data` depends on the
`is_base_game` value to find edits to the Skyrim base game cells.

To prevent this in the future, batch inserts when processing plugins is
no longer allowed to update cells which have `is_base_game = true`. The
only time we allow upserting these rows is when running the
`is_base_game` backfill which initially seeds the database with the base
game cells.

2025-03-02 14:15:05 -05:00

data

Fix bad interior cell data in db

2023-11-08 01:10:49 -05:00

migrations

Fix cells unique index

2023-11-08 16:07:00 -05:00

scripts

Enable updating skyrim mods

2022-09-24 19:58:26 -04:00

src

Prevent overwriting of base game cells is_base_game value

2025-03-02 14:15:05 -05:00

.gitignore

Add command for writing cell edits over time

2023-11-15 16:59:28 -05:00

Cargo.lock

Add command for writing cell edits over time

2023-11-15 16:59:28 -05:00

Cargo.toml

Add command for writing cell edits over time

2023-11-15 16:59:28 -05:00

drop_all.sql

Rename drop_all.sql file

2021-07-29 01:01:27 -04:00

README.md

Prevent overwriting of base game cells is_base_game value

2025-03-02 14:15:05 -05:00

README.md

modmapper

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

Development Install

Install and run postgres (v15 or later).
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

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

Install sqlx_cli with cargo install sqlx-cli --no-default-features --features postgres
Run sqlx migrate --source migrations run which will run all the database migrations.
Get your personal Nexus API token from your profile settings and add it to the .env file:

NEXUS_API_KEY=...

Build the release binary by running cargo build --release.
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.)
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 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