Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/difegue/doujinsoft
Web Shop/Archive for WarioWare DIY games.
https://github.com/difegue/doujinsoft
diy hacktoberfest java mio warioware
Last synced: 3 months ago
JSON representation
Web Shop/Archive for WarioWare DIY games.
- Host: GitHub
- URL: https://github.com/difegue/doujinsoft
- Owner: Difegue
- License: gpl-3.0
- Created: 2017-04-27T00:00:18.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-24T22:34:25.000Z (4 months ago)
- Last Synced: 2024-10-13T03:48:30.268Z (3 months ago)
- Topics: diy, hacktoberfest, java, mio, warioware
- Language: Java
- Homepage: https://diy.tvc-16.science/
- Size: 88.2 MB
- Stars: 51
- Watchers: 4
- Forks: 6
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# DoujinSoft
[](https://hub.docker.com/r/difegue/doujinsoft/)
Java Web Application for managing and distributing WWDIY content.
Relies on [DIYEdit](https://github.com/xperia64/DIYEdit) and [Mio-Micro](https://github.com/yeahross0/Mio-Micro).
Uses SQLite, materializeCSS and jQuery.
## Features
* .mio files dropped into the Webapp's data directory are parsed and added to the archive (on every app restart)
* Searchable lists with pages for every content (Games/Comics/Records)
* Comics can be directly read through the user's browser
* Records can be listened to through the browser (uses [mio-midi](https://www.npmjs.com/package/mio-midi))
- Midi files are played back using a custom soundfont based on [this one](https://musical-artifacts.com/artifacts/490).
* All the content available on the archive can be automatically inserted into a game save provided by the user.
* Basic JSON API.
## Using the API
Adding `&format=json` to most search pages in the webapp will give you a JSON equivalent. Use at will! 🙋♂️
## Environment variables
* WII_NUMBER: Wii Friend Code associated to the DoujinSoft WiiConnect24 account.
* WII_FALLBACK: Wii Friend Code that will receive Wii Mail forwarded from DoujinSoft.
* WC24_SERVER: WiiConnect24 server URL. Currently, there's only really `rc24.xyz`...
* WC24_PASSWORD: Password for the DoujinSoft WiiConnect24 account
* WC24_DEBUG: Add this variable to log additional Wii Mail data.
* DSOFT_PASS: Password for the Admin console.
* WEBHOOK_URL: URL for a webhook. This hook is hit whenever new content is uploaded to DoujinSoft.
## Deploy/develop on Codespaces
You can use [GitHub Codespaces](https://github.com/Difegue/DoujinSoft/codespaces) to develop on the app using the provided configuration.
Once in the codespace, you should be able to use `npm run dev-server` to immediately build/start a DoujinSoft instance.
## Deploying through Docker
You can deploy the provided [Docker image](https://hub.docker.com/r/difegue/doujinsoft) by mapping a volume to /home/doujinsoft:
```
docker run --mount type=bind,src=/my/data/directory,dst=/home/doujinsoft -p 8080:8080 difegue/doujinsoft
```
If you want to use WC24 interop, the environment variables WII_NUMBER, WII_FALLBACK, WC24_SERVER and WC24_PASSWORD must be defined.
## Deploying manually
Get the [release WAR](https://github.com/Difegue/DoujinSoft/releases) (or just build it with maven from the sources)
Edit your tomcat context to specify your data directory:
```
nano /var/lib/tomcat8/conf/context.xml
```
Create the folder you specified in the Parameter (here /home/DoujinSoft-data), and add .mio files to a "mio" subfolder in it.
Don't forget to make it R/W by your tomcat server.
```
cd /home
mkdir DoujinSoft-data
chown tomcat8 DoujinSoft-data/
chmod -R 755 DoujinSoft-data/
```
Drop the WAR into your tomcat webapps directory to start deployment.
If you have a tomcat installed to `/usr/local/tomcat`, you can use the provided `dev-server.sh` script to start a DoujinSoft instance.
Keep in mind said script will overwrite your ROOT.war, and requires the `/home/doujinsoft` directory to exist.
## Adding .mio files
Add .mio files to the "mio" subfolder in your data directory.
The files will be consumed and added to the database.
(This part might take a little time, benchmarks show a ~5 minutes deploy time for 2000 .mio files.)
You can then access the Webapp and check everything's working.
## Adding Collections
Collections allow you to display a specific subset of Games to the user through a simple JSON file.
Collection JSON files go in your data directory, subfolder "data/collections". An example file is included at the root of this project.
Correctly written collections will be linked in the home page of the Webapp.
## More screenshots
