Projects/minecraft-kartverket
2
1
Fork 0
Code Issues 7 Pull Requests Actions Activity

README: misc cleanup
All checks were successful
Build maps / build-bluemap (push) Successful in 33s
Details
Build maps / build-mapcrafter (push) Successful in 45s
Details

Browse Source
This commit is contained in:
Oystein Kristoffer Tveit
2026-01-14 17:56:23 +09:00
parent 584fd6379c
commit b0c855dc43
1 changed files with 42 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
README.md
View File

@@ -4,7 +4,8 @@ Map markers for PVV's minecraft server
## What is this?
This project is meant to let PVV members contribute map data for PVV's minecraft server, like coordinates for bases, cities, and other points of interest.
This project is mainly a collection of markers for PVV's minecraft server.
It is meant to let PVV members contribute map data for PVV's minecraft server, like coordinates for bases, cities, and other points of interest.
These markers are written in python so that we can do things like generating points in a loop, calculating distances, and other types of automation.
The codebase includes a CLI tool that we use to export this data into the formats of several minecraft map implementations.
@@ -20,40 +21,49 @@ Grab the latest exports here:
## Marker sets
Here is an overview of the different marker sets, and what they are meant for.
Here is an overview of the different marker sets, and a short description of what goes where:
- **Overworld**
- Area Names: larger areas with names
- Buildings: important buildings and world wonders.
- Cities: an area that consist of several bases and/or public infrastructure.
- Homes: single bases consisting of 1-3 people.
- Huts: small huts, meant for visitors and travelers.
- Infrastructure: public infrastructure, like bridges, ports, tunnels, etc.
- Mines: public mines
- Nature: similar to "Area Names", but specifically for mostly untouched nature-named areas.
- Other: anything that doesn't fit into the other categories
- Railways: railways
- Roads: roads
- Villages: villages generated by minecraft (as opposed to player made cities)
### Overworld
- **Nether**
- Ice Tracks: ice tracks meant for boats.
- Other: anything that doesn't fit into the other categories
- Portals: named portals that lead back to the overworld.
- Railways: railways
| Directory | Description |
|----------------|-------------|
| Area Names | Large named areas or biomes |
| Buildings | Important buildings and world wonders |
| Cities | An area that consist of several bases and/or public infrastructure |
| Homes | Single bases consisting of 1-3 people |
| Huts | Small huts, meant for visitors and travelers |
| Infrastructure | Public infrastructure, like bridges, sea ports, tunnels, etc. |
| Mines | Public mines |
| Nature | Similar to `Area Names`, but meant for mostly untouched nature reserves or national parks. |
| Other | Anything that doesn't fit into the other categories |
| Railways | Railways, train tracks for transportation |
| Roads | Roads and paths, for walking |
| Villages | Villages generated by minecraft (player made cities go in `Cities`) |
- **The End**
- Other: anything that doesn't fit into the other categories
- Portals: end portals that send you back to the center of the map
### Nether
| Directory | Description |
|------------|-------------|
| Ice Tracks | Ice tracks meant for highspeed travel with boats |
| Other | Anything that doesn't fit into the other categories |
| Portals | Nether portals that lead back to the overworld |
| Railways | Railways, train tracks for transportation |
### The End
| Directory | Description |
|------------|-------------|
| Other | Anything that doesn't fit into the other categories |
| Portals | End portals that send you back to the center of the map |
## How to run the python code
> [!NOTE]
> There should be no external dependencies required to run the code.
> Please keep it that way.
You can either use `uv`, `nix` or the bundled `Makefile` with a bare python installation to run the project.
There should be no external dependencies to run the code.
In the following sections of the readme, we will assume that you are using `uv`, but the other methods can also be adapted to the instructions.
### Using uv
If you have [uv](https://docs.astral.sh/uv/) installed, running the code is as easy as executing
@@ -87,6 +97,11 @@ nix build .#mapcrafter-export
nix develop
```
> [!NOTE]
> In the following sections of the readme,
> we will assume that you are using `uv`.
> But the other methods can also be adapted to the instructions.
## How to add a point marker
1. Find the correct marker set file in `src/marker_sets/<world>`.