diff --git a/.gitignore b/.gitignore index d2f444d..c2db4fe 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,6 @@ # Autosave *.autosave + +# Build Dir +[Bb]uild/ diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..4013698 --- /dev/null +++ b/COPYING @@ -0,0 +1,26 @@ +Redistribution and use in source and binary forms, with +or without modification, are permitted provided that the +following conditions are met: + +1. Redistributions of source code must retain this list + of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce this + list of conditions and the following disclaimer in the + documentation and/or other materials provided with the + distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND +CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED +WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A +PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, +PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH +DAMAGE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..20e2404 --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +# TouHou Player + +TouHou BGM player for all platform. + +## Usage + +No need for config. Drag the TouHou game program into `thplayer` main window, or click the **Load** button and choose the game folder. `thplayer` will automatically load songs and then it's ready for use! + +## Support game versions + +The Touhou game versions we support are: + +th07, th08, th09, th10, th11, th12, th13, th14, th15, th16 +th095, th125, th128, th143 + +This is all made possible by the [thpatch/thtk](https://github.com/thpatch/thtk/) project. Thanks! + +## Build + +### Build using `qmake` + +You can choose to build TouHou Player using `qmake` normally. + +``` shell +# Clone the repo +git clone --recurse-submodules https://github.com/BearKidsTeam/thplayer.git +# Create a build folder +mkdir ./thplayer/build && cd $_ +# Build it +qmake ../thplayer.pro && make && make clean +``` + +After that, you'll get the runnable binary inside the build folder. Enjoy! + +### Build manually + +To build it manually, get Qt open-source version from [qt.io](https://www.qt.io/download-open-source/) or from your package manager, install it and open `thplayer.pro` using QtCreator, and build it as you wish! + +## License + +### BSD 2-Clause License + +``` plain +Redistribution and use in source and binary forms, with +or without modification, are permitted provided that the +following conditions are met: + +1. Redistributions of source code must retain this list + of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce this + list of conditions and the following disclaimer in the + documentation and/or other materials provided with the + distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND +CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED +WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A +PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, +PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH +DAMAGE. +``` \ No newline at end of file