Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beyond-all-reason/maps-metadata
Repository holding metadata about maps used in the game.
https://github.com/beyond-all-reason/maps-metadata
Last synced: 9 days ago
JSON representation
Repository holding metadata about maps used in the game.
- Host: GitHub
- URL: https://github.com/beyond-all-reason/maps-metadata
- Owner: beyond-all-reason
- License: apache-2.0
- Created: 2023-03-31T10:37:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-27T22:18:50.000Z (6 months ago)
- Last Synced: 2024-05-28T08:08:14.082Z (6 months ago)
- Language: TypeScript
- Size: 846 KB
- Stars: 3
- Watchers: 4
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Maps metadata
=============
This repository contains metadata for maps used in Beyond All Reason game.
It contains files that work as source of truth that is then used by different
components in the BAR infrastructure, and build scripts that manipulate and
validate that information.
For more convenient data input, the source of truth resigning in `map_list.yaml`
file is actually automatically generated by data export from BAR's
[Rowy](https://www.rowy.io/) instance: https://rowy.beyondallreason.dev/.
See [scripts/js/src/update_from_rowy.ts](scripts/js/src/update_from_rowy.ts).
Development
-----------
Mostly, you modify the source of truth files, commit via pull request and
it gets deployed via GitHub Actions workflow.
When you are changing scripts, it's useful to be able to regenerate files
manually and check if all is working correctly. It's possible to do it in two
different ways:
- directly (Linux or in WSL): preferred for development as editor has an easy
access to everything
- inside a Docker container: primarily for hermetic testing
### Local environment
Make sure you have python, curl, Node.js and unzip installed (see Dockerfile for
the full list of dependencies), and then run install script to setup an isolated
environment for the development.
```
./scripts/install.sh
```
Then we need to setup a few environment variables to make sure that installed
dependencies are correctly visible in `PATH`
```
source .envrc
```
Hint: `.envrc` is a [direnv](https://direnv.net/) compatible file.
To make sure that your editor is correctly resolving all types (e.g. generate
TypeScript type definitions from JSON Schema), make sure to run
```
make types
```
### Docker environment
Build image with current version of the code, it does basically what steps above
but in a docker container.
```
docker build . -t maps-metadata-build
```
Get into the docker container shell
```
docker run -it --rm maps-metadata-build
```
Note: if you later need to copy some files *out* of the docker container, read
about `docker cp`.
### Build artifacts
Generation of output files is done using Makefile, so run
```
make -j $(nproc)
```
to regenerate all files in the `gen/` directory, and then
```
make -j $(nproc) test
```
to run additional checks on them.
To cleanup generated files, simply run `make clean`.
Documentation
-------------
See GitHub wiki for more documentation.