Browse Source

Added a License file and updated the README a bit to be cleare this is very work in progress.

master
DomtronVox 8 months ago
parent
commit
6abc6d0f82
2 changed files with 32 additions and 3 deletions
  1. +21
    -0
      LICENSE
  2. +11
    -3
      README.md

+ 21
- 0
LICENSE View File

@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 DomtronVox

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

+ 11
- 3
README.md View File

@@ -1,7 +1,13 @@
Very pre-alpha, not usable yet.

# ModEasy
ModEasy is a small, customizable library that provides easy modding support to any project. A Mod can stand for module or modification and is a package of data and/or code that adds onto or overrides the original data and/or code.

## Features
# License

MIT, see LICENSE file for details or https://choosealicense.com/licenses/mit/.

## Planned Features

* Support Linux, Windows, and MacOS.
* Functional out of the box.
@@ -9,11 +15,13 @@ ModEasy is a small, customizable library that provides easy modding support to a
* Mod types of: configuration files (no code), pre-compiled library (dll, so, etc), and Lua.
* Mod dependency handling. Automatically builds a dependency tree that loads mods in a certain order allowing mod inter-dependency with the option for load order overrides.
* API registration for both the core project and mods that allows calling those registered functions from each supported mod type.
* Network code for querying info and retrieving mods from an online repository.
* Customizable
* Custom configuration file type(s). Add additional configuration file loaders and/or override the default.
* Custom Mod handlers to add additional modding languages.
*
* TODO: single header?
* Customize functionality of the network code.
* Add hooks to the API registration code.
* Single header option if possible.

## Build Instructions



Loading…
Cancel
Save