Skip to content

Commit 81bd7c8

Browse files
author
tyharwood
committed
Update readme
1 parent 8e5a5e3 commit 81bd7c8

File tree

3 files changed

+26
-2
lines changed

3 files changed

+26
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
# Old World Mapmaker
2-
This is an unofficial XML generator that converts 3 RGB bitmaps to a map for the game [Old World](https://en.wikipedia.org/wiki/Old_World_(video_game)) by [Mohawk Games](https://en.wikipedia.org/wiki/Mohawk_Games). I thought it was amazing the maps were all just in plain XML and wanted an easy way to make maps in an Image editor, so this is what I came up with. You could also use this to convert maps from other games to to here provided you keep the import/export palette the same.
2+
This is an unofficial XML generator that converts 3 RGB bitmaps to a map for the game [Old World](https://en.wikipedia.org/wiki/Old_World_(video_game)) by [Mohawk Games](https://en.wikipedia.org/wiki/Mohawk_Games). I thought it was amazing the maps were all just in plain XML and wanted a lighter-weight way to make maps outside of the in-game editor, so I made this. The main use-case for this is to make a map first as a bitmap in an image editor like GIMP or Photoshop, then use this to transform your layers into XML.
33

44
### Installation
55
This has been rolled into a python package and CLI application. You can install the python package for Python 3.[ ]+ with pip,
66

7-
`pip install b`
7+
`pip install owmap`
88

99
To set up a development environment I suggest using uv. After cloning the repository sync with the all dependency groups:
1010

1111
`uv sync --all-groups`
1212

1313
### CLI Basic usage
1414

15+
[image](./docs/pipeline.svg)
16+
1517
```
1618
owmap [-h] [--mapname MAPNAME] [--terrainmap TERRAINMAP]
1719
[--heightmap HEIGHTMAP] [--vegmap VEGMAP]

docs/pipeline.puml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
@startuml design
2+
!theme aws-orange
3+
skinparam DatabaseFontColor White
4+
skinparam ArrowFontColor Whitesmoke
5+
6+
component owmap
7+
8+
file terrain as "Terrain Map"
9+
file height as "Height Map"
10+
file veg as "Vegetation Map"
11+
12+
file xml as "XML Code"
13+
14+
15+
owmap --> xml
16+
terrain --> owmap
17+
height --> owmap
18+
veg --> owmap
19+
20+
21+
@enduml

docs/pipeline.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)