readme + oops license markdown

This commit is contained in:
yosh 2023-05-07 23:51:32 -04:00
parent 33565ebd45
commit 6843ab68d0
2 changed files with 19 additions and 1 deletions

View File

@ -1,7 +1,8 @@
Avali Skin for Celeste
Copyright 2023 yosh
The material in `SourceCode` and `Effects` is licenced under (GPL 3.0 or Later)[https://spdx.org/licenses/GPL-3.0-or-later.html].
The material in `SourceCode` and `Effects` is licenced under [GPL 3.0 or Later](https://spdx.org/licenses/GPL-3.0-or-later.html).
The material in `Assets` is licensed under [Creative Commons Attribution Non Commercial Share Alike 4.0 International](https://creativecommons.org/licenses/by-nc-sa/4.0/), except for the following:
- `Graphics/Atlases/Gameplay/objects/Avali/lookout/badeline*.png` are all copyright of Extremely OK Games.

17
README.md Normal file
View File

@ -0,0 +1,17 @@
# Avali Skin
this is the repository for the [Avali Skin mod](https://gamebanana.com/mods/375726) for celeste
# Compiling
## Libraries
libraries are placed in `SourceCode/Libraries`. all the required libraries are listed in the makefile. the celestenet libraries can be extracted from [celestenet](https://gamebanana.com/mods/53695), and you can symlink/copy the other libraries from the celeste program directory
## Linux
there's a makefile in `SourceCode` that can build the dll and the required shaders for the mod:
- DLL: `make`
- Shaders: `make shader_c`
for compiling shaders, you need `D3DCompiler_43.dll`, `d3dx9_43.dll`, and `fxc.exe`, which can be found via wine/proton installations (more details in makefile). place these directly in `SourceCode` and not in `Libraries`, since windows searched the current working directory for libraries as well
### Linux Dependencies
all you need are the mono headers and `mcs`, the mono c# compiler
- Void Linux: `xbps-install mono-devel`
## Windows
umm uhhh ummmmm