Skip to content

Commit f477807

Browse files
authored
Updated README
1 parent fee6061 commit f477807

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

README.md

+16-12
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,33 @@
22
Maps, tilesets, and assets oh my!
33

44

5-
## MAP GURU USAGE
6-
1. Clone this repo: https://github.com/gathertown/mapmaking.git
7-
( I put it in my local "Gather" directory as "mapmaking". )
8-
2. Use some sort of git management program (I use Fork) or be a boss and go comand-line.
9-
3. Before you start at the beginning of the day, Fetch.
10-
4. If you make a change to the repo, Merge and Push.
5+
## Use
6+
### Basic Usage
7+
**"I just want one thing"**
8+
1. Find the tileset(s) or map(s) you want, assume it'll be up to date. Download it.
9+
2. Expect it will get out of date.
10+
^ probably best for background/foreground image files. If you're planning on modifying something, pls clone the repo!
11+
If you have any questions or troubles, let me know.
1112

12-
## BASIC USAGE
13+
### MAP GURU USAGE
14+
**"I'm want to change something"**
15+
0. (recommended) use some sort of git management program (I use Fork), or be a boss and go comand-line.
1316
1. Clone this repo: https://github.com/gathertown/mapmaking.git
14-
2. Find the thing you want, assume it'll be up to date. Download it.
15-
^ probably best for image files. If you're planning on modifying something, come use the repo!
16-
If you have any questions or troubles, let me know.
17+
( I put it in my local "Gather" directory as "mapmaking". )
18+
2. Before you start at the beginning of the day, Fetch.
19+
3. If you make a change to the repo, Merge and Push.
1720

1821
Because all the tiled files (TMX / TSX) use relative paths, we're golden. Everything is self-contained in the repo, or even if you have side-projects that reference this repo, it should still work.
1922

20-
## Structure
23+
## File Structure
2124
### mapmaking
2225
#### 📁 maps
2326
map files (.tmx) / background files (.png) / foreground files (.png) / photoshop files (.psd)
27+
divided into project-based directories
2428
#### 📁 tilesets
2529
tileset files (.tml) and source files (.png)
2630
#### 📁 assets
27-
asset files (.png) and photoshop source files (.psd)
31+
individual asset files (.png) and photoshop source files (.psd)
2832

2933
## Tileset Naming Convention
3034
### for tilesets (.tsx)

0 commit comments

Comments
 (0)