Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
CosmoCortney committed Jun 9, 2024
1 parent aa68a66 commit b158b4d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
1 change: 0 additions & 1 deletion MungPlex/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
cmake_minimum_required (VERSION 3.16)
project(MungPlex VERSION 2.4.0)

# Find lua
find_package(Lua REQUIRED)
find_package(sol2 CONFIG REQUIRED)
find_package(glfw3 CONFIG REQUIRED)
Expand Down
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Currently supported encodings:
- `UTF-32 LE`
- `UTF-32 BE`
- `Shift-Jis CP932`
- `Shift-Jis`
- `KS X 1001`
- `Jis X 0201 Full Width`
- `Jis X 0201 Half Width`
- `ISO-8859-1` - `ISO-8859-16`
Expand Down Expand Up @@ -457,26 +457,22 @@ A small conversion utility
- Convert RGB(A) to RGB(A)F, RGB565, RGB5A3 and vice versa

### Text Conversion
- Convert UTF-8 Text to UTF-16 Little Endian, UTF-16 Big Endian, UTF-32 Little Endian, UTF-32 Big Endian, Shift-Jis, Jis x 0201 Full Width, Jis X 0201 Half Width, ASCII, ISO-8859-1 - 16 and vice versa
- Convert UTF-8 Text to UTF-16 Little Endian, UTF-16 Big Endian, UTF-32 Little Endian, UTF-32 Big Endian, Shift-Jis CP932, KS X 1001 (EUC-KR), Jis x 0201 Full Width, Jis X 0201 Half Width, ASCII, ISO-8859-1 - 16 and vice versa

<a name="compiling"></a>
## Compiling

Open the project in Visual Studio as "Open as local folder".

Using `vcpkg`, make sure to install the following libraries (`vcpkg install xxx:x64-windows`):
* `sol2` ([example project](https://github.com/BullyWiiPlaza/Sol2WithCMake))
* `glfw3`
* `nlohmann-json`
* `discord-game-sdk`
* `boost`

To finally compile and launch `MungPlex`, select `MungPlex.exe` as startup item and build/debug as usual in Visual Studio.

<a name="todo"></a>
## TODO
- General
- Migrate `imgui` to using `vcpkg` (e.g. install `imgui[glfw-binding]`)
- Migrate `imgui` to using `vcpkg` (e.g. install `imgui[glfw-binding]` and [docking-experimental])
- Texture Streaming
- Corruptor
- Search
Expand All @@ -491,6 +487,7 @@ To finally compile and launch `MungPlex`, select `MungPlex.exe` as startup item
- Cheats
- Syntax Highlighting, more OS functionalities

You can find up-to-date ToDos and an idea list on the affiliated Discord Server (see above)

<a name="kiitos"></a>
## Special Thanks
Expand Down

0 comments on commit b158b4d

Please sign in to comment.