You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting-started.md
+11-2
Original file line number
Diff line number
Diff line change
@@ -4,14 +4,15 @@ This guide will show how to setup a local development environment to build, test
4
4
## Table of contents
5
5
*[Installation](#installation)
6
6
*[Building modules](#building-modules)
7
+
*[Common issues](#common-issues)
7
8
*[Submitting changes](#submitting-changes)
8
9
9
10
## Installation
10
11
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/).
11
12
12
13
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.
13
14
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.
15
16
```sh
16
17
# MacOS, Linux, or Git Bash (recommended)
17
18
curl -LsSf https://astral.sh/uv/install.sh | sh
@@ -40,7 +41,7 @@ uv run beet dev --link <world_name> --watch metallurgy *_shamir
40
41
```
41
42
*`uv run` makes sure that the command uses the correct Python dependencies
42
43
*`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)
44
45
*`--watch` watches for file changes and then rebuilds
45
46
*`metallurgy *_shamir` specifies the list of module IDs to build
46
47
@@ -49,6 +50,14 @@ Building the release version of all modules is also possible. It will output the
49
50
uv run beet -p beet-release.yaml build
50
51
```
51
52
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
+
52
61
## Submitting changes
53
62
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.
0 commit comments