WiiMart/WiiSOAP
1
0
Fork 0
mirror of https://wiilab.wiimart.org/wiimart/WiiSOAP synced 2025-09-03 20:11:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Write somewhat cleaner readme

Browse Source
This commit is contained in:
Spotlight 2022-07-06 11:50:51 -05:00
parent 2ac3a9c6cc
commit 63fbffeabc
No known key found for this signature in database
GPG Key ID: 874AA355B3209BDC
1 changed files with 9 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
README.md
View File

@ -4,58 +4,14 @@ Ideally, one day this will become feature complete enough to handle other titles
It aims to implement everything necessary to provide title tickets, manage authentication, and everything between.
> Note that this software is still in development. The schema ma
## Setup
WiiSOAP operates on the assumption that you run a PostgreSQL database holding existing tickets.
## What's the difference between this repo and [that other SOAP repo](https://github.com/OpenShopChannel/Open-Shop-SOAP)?
This is the SOAP Server Software. The other repository, [Open-Shop-SOAP](https://github.com/OpenShopChannel/Open-Shop-SOAP), holds templates of communication between a Wii and WSC's server.
1. Ensure that your PostgreSQL database contains the schema within `database.sql`.
2. Copy `config.example.xml` to `config.xml` and edit accordingly.
- Similar to [WSC-Patcher](https://github.com/OpenShopChannel/WSC-Patcher), you may use a base URL of `a.taur.cloud` for localhost development, i.e. via Dolphin.
3. `go build` to create an executable.
4. Run the resulting executable, such as `./WiiSOAP`.
# Changelog
Versions on this software are based on goals. (e.g 0.2 works towards SQL support. 0.3 works towards NUS support, etc.)
## 0.3.x Tanuki
### 0.3.0
- Migrate to using PostgreSQL
- Add routes and XML niceties
- Implement most routes
## 0.2.x Kawauso
### 0.2.6
*This version of WiiSOAP Server was brought to you by Apfel. Thank you for your contribution.*
- Fixed error handling.
- Moved configuration example.
- Added `go.mod` for an easier installation.
- Changed `SQLPort` to `SQLAddress` in the `config.xml` file.
### 0.2.5
*This version of WiiSOAP Server was brought to you by Apfel. Thank you for your contribution.*
- Fixed lint errors.
- Uses Fprintf properly now.
- Uses `if err = action(); os.IsExist(err) {}` now. This makes error checks a little bit shorter.
- Changed `Port` to `Address` in the `config.xml` file.
### 0.2.4
- Added SQL skeleton.
- Edited config template.
### 0.2.3
- Added TODO Items.
- Improved Error Handling.
- Bug fixes.
> Fixed an issue where converting string to byte in the switch cases would cause the program to not compile. Since converting to byte in switch is not possible. The program should now compile without any errors.
- Organized the script to make it easier to read.
- No changes to SQL have been made in this update.
### 0.2.2
- Switched from if else to switch case. This makes the script cleaner, and makes the program faster.
- No changes to SQL have been made in this update.
### 0.2.1
- Added working Config.
- SQL now works. (In terms of opening a connection.)
- You can now choose what port to run WiiSOAP on.
### 0.2.0
- Added SQL Driver.
- SOAP-GO-OSC is now just called WiiSOAP.
## 0.1 (No Codename)
### 0.1.2
- Optimised the software. (Structures are now in their own file.)
### 0.1.1
- Added IAS Support.
### 0.1.0
- Added ECS Support.
## Contributing
Ensure you have run `gofmt` on your changes.