From de72057ee1205a927cc806c012bfc653c44b904f Mon Sep 17 00:00:00 2001 From: Denis <93516910+Bussun@users.noreply.github.com> Date: Sun, 16 Jan 2022 16:11:47 +0100 Subject: [PATCH] License stuff and README update --- BMGEditor/FS/Compression.cs | 1 + LICENSE.md | 23 +++++++++++++++++++++++ README.md | 13 ++++++++++--- 3 files changed, 34 insertions(+), 3 deletions(-) create mode 100644 LICENSE.md diff --git a/BMGEditor/FS/Compression.cs b/BMGEditor/FS/Compression.cs index d09dabb..44b72a6 100644 --- a/BMGEditor/FS/Compression.cs +++ b/BMGEditor/FS/Compression.cs @@ -35,6 +35,7 @@ namespace BMGEditor { Array.Resize(ref data, decompSize); output.CopyTo(data, 0); + return; } header <<= 1; } diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..bd05bf7 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,23 @@ +Copyright 2022, Bussun and Luma contributors + +This license grants you the right to use, copy and redistribute the software **BINARIES** +(here the Luma text editor) if the following conditions are met: + - No commercial use + - A copy of this license is included + - A link to the repository and GitHub pages is included + +This license also grants you the right to edit the software if the following conditions are met: + - You must keep this license + - Any change you want to make public must be pushed to the main repository* +(*This means you can't redistribute a fork of this software) + +The main repository of this project is located at: https://github.com/Bussun/BMGEditor + +To avoid useless forks, just DON'T make one (even if you want to contribute) You are encouraged +to commit to the main repository. + +If you plan to use some parts of code from this project, you are allowed to if you credit it. +The software and its source code is provided "as-is" without any warranty +of any kind (I still hope it will be useful :) ) + +This license is subject to change. \ No newline at end of file diff --git a/README.md b/README.md index b609e00..e6298a0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# BMGEditor +# Luma An editor in C# to edit BMG files from Super Mario Galaxy ## Features @@ -15,7 +15,14 @@ An editor in C# to edit BMG files from Super Mario Galaxy If you notice a bug or if you think something's missing, please open an issue ### Other - Please avoid forking the repo if you don't plan to open a pull request later on. Contributions here are welcome + DON'T fork the repository. Contributions here are welcome, encouraged and recommended. + +## Building the software + Download and open the solution in Visual Studio Community. It should build without any issue ## Credits and license - Comming soon + You can find the license in LICENSE.md (It's short don't worry) + + Credits: + - The old C# version of Whitehole for RARC, BCSV and big endian code + - YAZ0 decoding code inspired by EveryFileExplorer \ No newline at end of file