Skip to content

Commit a453c59

Browse files
authored
Various changes and additions to Contribution doc (#1097)
1 parent 7b69a9b commit a453c59

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

docs/getting-started.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ This guide will show how to setup a local development environment to build, test
44
## Table of contents
55
* [Installation](#installation)
66
* [Building modules](#building-modules)
7+
* [Common issues](#common-issues)
78
* [Submitting changes](#submitting-changes)
89

910
## Installation
1011
To contribute to our project you need to install [Git](https://git-scm.com/downloads) and a text editor. We recommend [VSCode](https://code.visualstudio.com/).
1112

1213
Our modules are built using [beet](https://github.com/mcbeet/beet), which is a Python framework that allows us to automatically validate and generate part of our data packs and resource packs.
1314

14-
You will need to install [uv](https://docs.astral.sh/uv/) as project manager. If you don't already have Python installed, uv will do that automatically.
15+
You will need to install [uv](https://docs.astral.sh/uv/) as project manager. If you don't already have Python installed, uv will do that automatically. We currently use Python 3.10.
1516
```sh
1617
# MacOS, Linux, or Git Bash (recommended)
1718
curl -LsSf https://astral.sh/uv/install.sh | sh
@@ -40,7 +41,7 @@ uv run beet dev --link <world_name> --watch metallurgy *_shamir
4041
```
4142
* `uv run` makes sure that the command uses the correct Python dependencies
4243
* `beet dev` builds the data packs to the `out` folder
43-
* `--link <world_name>` copies the packs to a local world
44+
* `--link <world_name>` copies the packs to a local world (filepath to the world's directory)
4445
* `--watch` watches for file changes and then rebuilds
4546
* `metallurgy *_shamir` specifies the list of module IDs to build
4647

@@ -49,6 +50,14 @@ Building the release version of all modules is also possible. It will output the
4950
uv run beet -p beet-release.yaml build
5051
```
5152

53+
## Common issues
54+
When building the modules, sometimes you will encounter odd errors.
55+
56+
If you get an error about a beet plugin exception, many times it can be resolved simply by refreshing the beet cache.
57+
```
58+
uv run beet cache --clear
59+
```
60+
5261
## Submitting changes
5362
To submit changes to our modules, start by creating a branch. This allows us to review every change separately and allows you to make other changes in the future. Make sure you are on the `master` branch when you do this.
5463

0 commit comments

Comments
 (0)