Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amoeba/ace-to-sqlite
Automation to export the latest release of the ACE data as SQLite databases served via Datasette
https://github.com/amoeba/ace-to-sqlite
acemulator asherons-call database datasette sqlite
Last synced: 27 days ago
JSON representation
Automation to export the latest release of the ACE data as SQLite databases served via Datasette
- Host: GitHub
- URL: https://github.com/amoeba/ace-to-sqlite
- Owner: amoeba
- License: agpl-3.0
- Created: 2023-01-23T07:44:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-22T06:03:30.000Z (about 2 months ago)
- Last Synced: 2024-10-10T22:23:32.851Z (about 1 month ago)
- Topics: acemulator, asherons-call, database, datasette, sqlite
- Language: Shell
- Homepage: https://acedb.treestats.net
- Size: 63.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ace-to-sqlite
Automation to export the latest releases of [ACEmulator](https://github.com/ACEmulator) data as SQLite databases served via [Datasette](https://datasette.io).
See it live at https://acedb.treestats.net.
## Databases
The following data sources are included:
- `ace_world_base`: https://github.com/ACEmulator/ACE-World-16PY
- `ace_world_patches`: https://github.com/ACEmulator/ACE-World-16PY-Patches
- `ace_pcap_exports`: https://github.com/ACEmulator/ACE-PCAP-Exports
- `ace`: https://github.com/ACEmulator/ACE (via [dogsheep](https://dogsheep.github.io/))
## Rationale
People sometimes want to know if certain items are in the game or build things on top of ACE data.
The best way to do this is to query the ACE database.
This makes that (and more) easier.
## Methodology
I didn't find a good tool that can directly convert MySQL DDL (What ACE stores its data as) to SQLite DDL (what we need for loading into [Datasette](https://datasette.io)).
After trying to some things, I settled on the following set of steps:
- Spin up a MySQL instance
- Load MySQL DDL files in
- Run a custom version of [db-to-sqlite](https://datasette.io/tools/csvs-to-sqlite)
- Publish to Fly.io with [Datasette](https://datasette.io).
## Running This Yourself
This automation is a GitHub Action so please look at https://github.com/amoeba/ace-to-sqlite/blob/main/.github/workflows/export.yml for the steps.
If you're interested in running the automation yourself and in another environment, look at https://github.com/amoeba/ace-to-sqlite/blob/main/scripts/generate_world_database.sh which will download and convert the latest ACE World release to SQLite. Its requirements are:
- A local MySQL server instance with the root password off
- bash
- curl
- jq
- unzip
- Python
- db-to-sqlite (Installed from [my fork](https://github.com/amoeba/db-to-sqlite))
## How this GitHub Repository Works
This repo can automatically pull in a specific ACE database release using GitHub Actions.
To pull a new release and re-publish the database, run:
```sh
export ACE_TAG="changeme"
git tag -a $ACE_TAG -m "$ACE_TAG"
git push --follow-tags
```
## Deployment
https://acedb.treestats.net/ is deployed on a private VPS running Dokku so only I can perform a deployment.
Here are my steps:
- Publish a new "latest" release by re-tagging "latest" and pushing to the repo
```sh
git tag -d latest
git tag -a latest -m latest
git push --force --tags
```
- Wait for the Action to finish
- Push to dokku VPS
## Contributing
Please file an [Issue](https://github.com/amoeba/ace-to-sqlite/issues) if you have any questions or commands. An example of a good type of issue to file would be if you want a datasource included here that isn't or if you find either a data or documentation issue.