Skip to content

Commit b23c66c

Browse files
authored
Update README with new TODO items and formatting
1 parent bdab032 commit b23c66c

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ It's funny, you spend 30 minutes in a game, realize you've seen all of it, 400 h
55

66
Anyway, this mod's goal is to offer what is essentially a full map-making toolkit. Right now it's a bit rough, but I plan on smoothing out those edges a bit.
77

8-
## TODO
9-
- [X] Load a map successfully
10-
- [X] Load map but in a lazy way (Loads when needed, not at game start)
11-
- [X] Unload map when exit
8+
## TODO <sup>(In no specific order.)</sup>
129
- [ ] Finish scripting system [Partially done!]
10+
- [ ] Distribution Format
1311
- [ ] Create working damageable
1412
- [ ] Make components for easy creation of different object types
1513
- [ ] Create an SDK for use in Unity
16-
- [ ] Maybe fix additional things
14+
- [ ] Make an in-game editor
15+
- [ ] Documentation
16+
- [ ] Website for documentation
1717

18-
This mod is made with Melonloader in mind. Not BepInEx.
18+
> This mod is made with Melonloader in mind. Not BepInEx.
1919
2020
## Error Reporting
2121
This mod reports errors to a server hosted by rkxspace.
@@ -54,13 +54,15 @@ Here is a template to get started:
5454
]
5555
}
5656
```
57-
(Comments will work. Don't worry!)
57+
> Comments are ignored by newtonsoft.json.
58+
> Unused fields are ignored by the mod. Implementations are planned.
5859
5960
To make a map, create a project in Unity 6000.0.27f1 using the URP pipeline. After creating the project, create a scene with the name format of `Author.MapName`. Add the scene to an assetbundle. As of right now, components needed to create buildings and such need to be stubbed by the user. The root game objects should be the following:
6061
- SceneObjects - For objects in the scene, thats it.
6162
- SceneConfig - Left for the mod to handle, expected to be there. Occasionally could be useful.
6263

6364
After building the bundle, add the entry for your map to the `maps.json` file. AssetFile should be the same as your scene name, and the bundle should be placed as `Author/MapName.pawbox`
6465

65-
# Small Notice
66-
- rkxspace and this project are **not affiliated with nor endorsed by Dare Looks**.
66+
<img src="https://github.com/rkxspace/PawMapLoader/blob/master/assets/rkxspacemulti.png?raw=true" alt="rkxspace" width="400" height="300">
67+
68+
<sup>rkxspace and this project are **not affiliated with nor endorsed by Dare Looks**.</sup>

0 commit comments

Comments
 (0)