Skip to content

Commit cfe1164

Browse files
authored
Update README.md
1 parent bce09cd commit cfe1164

File tree

1 file changed

+40
-21
lines changed

1 file changed

+40
-21
lines changed

README.md

Lines changed: 40 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,16 @@ A modern implementation of 'LocoTool' for Locomotion `dat` file parsing and edit
33

44
# Screenshots
55

6-
Object property editing | Graphics viewing
7-
:-------------------------:|:-------------------------:
8-
![image](https://github.com/user-attachments/assets/5178ca31-aa9f-4fb7-a026-d24f98dbe65a) | ![image](https://github.com/user-attachments/assets/b04b106c-2cce-4d4e-b8da-e655eede5bc1)
6+
| **Object property editing** | **Graphics viewing** |
7+
|:-----:|:-----:|
8+
| ![image](https://github.com/user-attachments/assets/1adb4be5-cc8e-46a0-9174-83e0634c2ad2) | ![image](https://github.com/user-attachments/assets/bb0aec69-c3ba-4edf-aba0-1861d99077a2) |
9+
| **String table editing** | **Light/dark mode** |
10+
| ![image](https://github.com/user-attachments/assets/dd97a5cd-5208-4c0c-8215-e3692bfbe90e) | ![image](https://github.com/user-attachments/assets/3c7cc173-a001-47e4-8ab7-34ca80b2307a) |
911

1012
# How to use
1113

1214
## 1. Load an object folder
13-
1. Click `File` -> `ObjData Directories` -> `Add New`, which will open a folder browser window
15+
1. Click `ObjData` -> `Add new folder`, which will open a folder browser window
1416
2. Navigate to a folder that contains Locomotion object files
1517
3. Click `Select Folder` to close the folder browser window
1618
4. The tool will load all objects in that folder and display them in the tree view on the left of the tool
@@ -22,6 +24,20 @@ Object property editing | Graphics viewing
2224

2325
# Features
2426

27+
## 2.0.0
28+
29+
- Cross-platform
30+
- Dark mode
31+
- Flag editing support
32+
- Locomotion `ObjData` folder:
33+
- Can open and edit all object types
34+
- Can save object types back to `dat` file format (albeit with no encoding)
35+
- Can display image table and string table of all objects (and sound data for SoundObject), and allow editing of them
36+
37+
## 1.0.5
38+
39+
- Windows-only
40+
- Property/hex viewer
2541
- Locomotion `ObjData` folder:
2642
- Can open and edit all object types
2743
- Can save object types back to `dat` file format (albeit with no encoding)
@@ -50,8 +66,10 @@ Object property editing | Graphics viewing
5066
# Misc
5167

5268
## Settings
53-
- The program settings file, `settings.json` will be created on first startup in `%APPDATA%\\Roaming\\OpenLoco Object Editor\\`
54-
- This is where the users' object folder paths are saved, and other program data
69+
- The program settings file, `settings.json` will be created on first startup. It is located at:
70+
- Windows: `%APPDATA%\\Roaming\\OpenLoco Object Editor\\`
71+
- Linux/macOSX: `/~/<user>/.config/OpenLoco Object Editor`
72+
- This file is used to store where the users' object folder paths are, and other program data
5573

5674
## Indexing
5775
- When the tool first loads an objdata directory it will scan every file to make an index and save that into `objectIndex.json` in that folder
@@ -68,18 +86,19 @@ Object property editing | Graphics viewing
6886
- Checks that the reloaded file is the same as the originally-loaded file, byte for byte. This is a byte comparison of the *decoded and decompressed* bytes, not the *on-disk* bytes
6987

7088
# Future Plans/Features
71-
- Better flag editing support
72-
- Validation of object limits/sane values
73-
- Detection of bugged objects
74-
- Support/edit tutorials
75-
- Support/edit maps/savegames/scenarios
76-
- Support language files
77-
- Implement vehicle previewer
78-
- Better G1 support including palette file editing
79-
- Export/convert object to a future modern OpenLoco file format
80-
- Dark modern
81-
- Cross-platform support
82-
- Full unit-testing suite
83-
- Blank template objects for object creation from scratch
84-
- Use a proper C# image library for image creation instead of WinForms
85-
- ...many more things
89+
- [ ] Better flag editing support
90+
- [ ] Validation of object limits/sane values
91+
- [ ] Detection of bugged objects
92+
- [ ] Support/edit tutorials
93+
- [ ] Support/edit maps/savegames/scenarios
94+
- [ ] Support language files
95+
- [ ] Implement vehicle previewer
96+
- [ ] Better G1 support including palette file editing
97+
- [ ] Export/convert object to a future modern OpenLoco file format
98+
- [ ] Dark modern
99+
- [ ] Cross-platform support
100+
- [ ] Full unit-testing suite
101+
- [ ] Blank template objects for object creation from scratch
102+
- [ ] Use a proper C# image library for image creation instead of WinForms
103+
104+
...many more things

0 commit comments

Comments
 (0)