Skip to content

Commit

Permalink
Add licensing and readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
miyu committed Nov 24, 2015
1 parent 3717be2 commit d2362ba
Show file tree
Hide file tree
Showing 5 changed files with 92 additions and 0 deletions.
14 changes: 14 additions & 0 deletions License - Dargon.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
This file is part of The Dargon Project.

The Dargon Project is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

The Dargon Project is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with The Dargon Project. If not, see <http://www.gnu.org/licenses/>.
10 changes: 10 additions & 0 deletions License - ItzWarty.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Copyright (c) 2012, Michael Yu / ItzWarty
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, 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 HOLDER 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.
4 changes: 4 additions & 0 deletions README - Licensing
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
License of code in this repo: BSD (License - ItzWarty.txt)
License of code in submodules: See submodules themselves.

This code is NOT dual licensed! :P
56 changes: 56 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# The Dargon Project
Dargon is NOT FEATURE COMPLETE nor FULLY FUNCTIONAL! See the [Issue Tracker](https://github.com/the-dargon-project/the-dargon-project/issues) for more information.

### Tl;Dr
The Dargon Client facilitates the safe installation of League of Legends modifications. We are unique in that we apply modifications in-memory; no game data is directly overwritten, which prevents client data corruption. We hope to support other games in the future.

Nest/Dargon (aka Dargopia) aims to become a .net application framework. End goals and key strengths should be client-side deployment, building multiprocess applications, and self-hosting at small-to-medium scale.

### Maintainers and Contributors
You may contact me at [/r/dargon](//reddit.com/r/dargon) or [@ItzWarty](//twitter.com/ItzWarty).

We want more developers! If you're looking to help out, there's a lot of up-for-grabs and cool stuff to be done.

Individuals who have contributed to Dargon in no particular order: Michael "ItzWarty" Yu, Adrian Astley, Ryan LaSarre, Eduardo Cabrera.

Special thanks goes to: Brian Chan, Richard Min, and a ton of mentors. Also, velkor2, yourbuddypal, themantrum, and GorbyRU for their efforts back in 2011.

## Building The Dargon Client
* git clone [this repository] .
* git submodule update --init
* explorer dargon-root.sln (or just manually open it)
* build the entire project to restore nuget packages
* git reset --hard
* build again.

## Terminology (It's confusing)
* the dargon project - the overall name of this effort.
* dargopia - our joke way of referring to all this work.
* dargon client - refers to League of Legends modding application.
* client - the GUI of the Dargon Client.
* core - daemon which does most of the client's busy work.
* trinket - hijacks other processes to override behavior.
* server - server-side code.
* platform - backend code.
* webend - e.g. APIs exposed over port 80.
* hydar - experimental (wip) in-memory data grid.
* nest - application deployment, patching, bootstrapping.
* libraries
* courier - udp-focused networking library
* management - jconsole for .net - lets you create debugging endpoints for applications without creating a proper gui.
* portable-objects - serialization library
* pof-streams - exposes pof streams and provides utilities for consuming them.
* ryu - IoC container integrated with Dargon's tech
* services - remote-method-invocation library
* random crap
* audits - wip, owner Brian Chan
* filesystems - abstracts filesystems, was once considered a good idea
* io - exposes filesystems as nodes.
* itzwarty.commons - useful extensions for .net
* itzwarty.proxies - proxy classes useful for testability
* scene - 3d scene-building api (wip)
* systemstate - useful for feature-toggle functionality
* league of legends - it's a fun game
* rads - reads Riot Application Distribution System files
* wgeo - reads map data
* libvfm - creates virtual file descriptors to tell trinket how files should look.
8 changes: 8 additions & 0 deletions dargon-root.sln
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,14 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "nest-bundle", "nest-bundle\
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "start-nest-core-and-client", "start-nest-core-and-client\start-nest-core-and-client.csproj", "{0C34F00A-3235-4E16-BB79-7467F47D3CF7}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{B1C7F2E4-06E2-4B0E-B6E9-A4DB161F19A9}"
ProjectSection(SolutionItems) = preProject
License - Dargon.txt = License - Dargon.txt
License - ItzWarty.txt = License - ItzWarty.txt
README - Licensing = README - Licensing
README.md = README.md
EndProjectSection
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Console|Any CPU = Console|Any CPU
Expand Down

0 comments on commit d2362ba

Please sign in to comment.