UShogi

UShogi

UShogi (Udon Shogi) is a VRChat implementation of Shogi using U#. Given away for free for anyone who wants to add shogi to their VR world

I would recommend using the github link instead as it's easier to update than on booth

## Features

- Automated controls and legal moves display

- Post-game review

- Export game to lishogi

- Timers

- Takebacks

- Dobutsu, CZ, and 1-kanji skins

- No Update calls, and only uses manual syncs

## Assets sources

Textures of the pieces and boards were taken from [Lishogi] (https://github.com/WandererXII/lishogi), Sounds are from [TAM Music Factory] (https://tam-music.com/).

## How to install

Assuming you have a Unity scene ready for your VRChat world:

- 1: import the package (or clone the github repository inside your VRChat project)

- 2: drag&drop the UShogi/Prefab/Ushogi.prefab (the actual playing board) prefab into your scene, place as many as you want in said scene, we'll call those in your scene the "UShogi instances"

- 3: drag&drop the UShogi/Prefab/UShogi SetSelection.prefab (the option to select which board/piece set to use) into your scene, we'll call the one dropped in your scene the "SetSelection instance"

- 4: select the "SetSelection instance", in the inspector you should see an array parameter "UShogi_prefabs"; drag&drop all of your "Ushogi instances" into the parameter

- 5: build and upload!

## Forking and Code modifications

In case you want to fork/modify the code of this system, the core components of the system are:

- UShogi_Board: manages the data representation of the board at current time, will decode the players' move and update its state

- UShogi_Visualizer: "draws" the board and manages the in-game controls

- UShogi_User: allows remote players to append moves to the board, the board itself is not synced, only the players are

This project was made under short time, so sorry in advance because some code is kinda dirty/duplicated to get results quickly

## License

This project uses the GNU GPL3. Haven't checked what it allows/limit to be honest, but basically feel free to do anything with this.

If you do make use of this project (either for code or for worlds) credits is not necessary, but appreciated.

## Other links

Github Page: https://github.com/jiray-yay/UShogi

Youtube demonstration: https://youtu.be/DJlYpNV2uS0

Demo World: https://vrchat.com/home/world/wrld_a5bd56a2-4f34-4372-99d3-9c4dbaa50b42/info