Skip to content

Commit

Permalink
Updated readme, contributors, and licenses
Browse files Browse the repository at this point in the history
  • Loading branch information
white-rabbit-dfplex committed May 18, 2020
1 parent e0fe37c commit 37f0cbd
Show file tree
Hide file tree
Showing 5 changed files with 185 additions and 35 deletions.
22 changes: 20 additions & 2 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,30 @@
# Contributors

Here is a non-exhaustive list of everyone whose work went into creating
DFplex and its ancestor, Webfortress.
DFplex and its ancestor, Webfortress. If you'd like to see someone's name on here, please contact an author or send a PR.

### DFPlex ###
```
white-rabbit
BenLubar
flbr
Paingouin
DaKnig
```

### Webfortress ###
```
mifki <[email protected]>
alloyed <[email protected]>
Dragoon209
```

### Special Thanks ###
```
Lethosar, who provided much advice.
Hexa, for setting up the first public server.
```

Special thanks also to lethosar, who provided much advice.

DFplex also uses tilesets/colorschemes created by the wider DF
community, their names can be found in the static/art and static/colors
Expand Down
4 changes: 2 additions & 2 deletions INSTALLING.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ from source, see the build instructions in the README.

Run dfhack. In the DFHack Console, you should see a line that says:

[WEBFORT] [2014-11-10 06:11:06] [application] Web Fortress started on port 1234
[DFPLEX] [2014-11-10 06:11:06] [application] DFPlex started on port 1234

If you see something like that, then Web Fortress has been properly installed. However,
If you see something like that, then DFPlex has been properly installed. However,
the port mentioned in the console here is not the one to connect to.

3. Port Forwarding
Expand Down
14 changes: 0 additions & 14 deletions LICENSE-webfort

This file was deleted.

178 changes: 162 additions & 16 deletions LICENSE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ tinyxml_ Zlib \(c\) 2000-2006, Lee Thomason
UTF-8-decoder_ MIT \(c\) 2008-2010, Bjoern Hoehrmann
webfort_ ISC \(c\) 2014, Vitaly Pronkin, Kyle Mclamb
cpp-httplib_ MIT \(c\) 2017, yhirose
websocketpp_ BSD 3-clause \(c\) 2014, Peter Thorson
ixwebsockets_ BSD 3-clause \(c\) 2018, Machine Zone
=============== ============= =================================================

.. _DFHack: https://github.com/DFHack/dfhack
Expand All @@ -50,7 +52,8 @@ cpp-httplib_ MIT \(c\) 2017, yhirose
.. _lua-profiler: http://lua-users.org/wiki/PepperfishProfiler
.. _webfort: https://github.com/Ankoku/df-webfort
.. _cpp-httplib: https://github.com/yhirose/cpp-httplib

.. _websocketpp: https://github.com/zaphoyd/websocketpp
.. _ixwebsockets: https://github.com/machinezone/IXWebSocket
.. _CC-BY-SA: http://creativecommons.org/licenses/by/3.0/deed.en_US


Expand Down Expand Up @@ -102,6 +105,40 @@ See https://en.wikipedia.org/wiki/MIT_License
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ISC License
===========
See https://en.wikipedia.org/wiki/ISC_license
::

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

ISC License
============
See https://en.wikipedia.org/wiki/ISC_license
::

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

BSD Licenses
============
See https://en.wikipedia.org/wiki/BSD_licenses
Expand Down Expand Up @@ -150,19 +187,128 @@ See https://en.wikipedia.org/wiki/BSD_licenses
permission. For written permission, please contact
[email protected]

ISC License
===========
See https://en.wikipedia.org/wiki/ISC_license
::
``websocketpp`` adds the following clause::

* Neither the name of the WebSocket++ Project nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.

``websocketpp`` also includes these licenses in "Bundled Libraries"::

****** Base 64 Library (base64/base64.hpp) ******
base64.hpp is a repackaging of the base64.cpp and base64.h files into a
single header suitable for use as a header only library. This conversion was
done by Peter Thorson ([email protected]) in 2012. All modifications to
the code are redistributed under the same license as the original, which is
listed below.

base64.cpp and base64.h

Copyright (C) 2004-2008 René Nyffenegger

This source code is provided 'as-is', without any express or implied
warranty. In no event will the author be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

1. The origin of this source code must not be misrepresented; you must not
claim that you wrote the original source code. If you use this source code
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.

2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original source code.

3. This notice may not be removed or altered from any source distribution.

René Nyffenegger [email protected]

****** SHA1 Library (sha1/sha1.hpp) ******
sha1.hpp is a repackaging of the sha1.cpp and sha1.h files from the shallsha1
library (http://code.google.com/p/smallsha1/) into a single header suitable for
use as a header only library. This conversion was done by Peter Thorson
([email protected]) in 2013. All modifications to the code are redistributed
under the same license as the original, which is listed below.

Copyright (c) 2011, Micael Hildenborg
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.
* Neither the name of Micael Hildenborg nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY Micael Hildenborg ''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 Micael Hildenborg 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.

****** MD5 Library (common/md5.hpp) ******
md5.hpp is a reformulation of the md5.h and md5.c code from
http://www.opensource.apple.com/source/cups/cups-59/cups/md5.c to allow it to
function as a component of a header only library. This conversion was done by
Peter Thorson ([email protected]) in 2012 for the WebSocket++ project. The
changes are released under the same license as the original (listed below)

Copyright (C) 1999, 2002 Aladdin Enterprises. All rights reserved.

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.

L. Peter Deutsch
[email protected]

****** UTF8 Validation logic (utf8_validation.hpp) ******
utf8_validation.hpp is adapted from code originally written by Bjoern Hoehrmann
<[email protected]>. See http://bjoern.hoehrmann.de/utf-8/decoder/dfa/ for
details.

The original license:

Copyright (c) 2008-2009 Bjoern Hoehrmann <[email protected]>

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.
2 changes: 1 addition & 1 deletion server/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
if (CMAKE_CXX_COMPILER_VERSION VERSION_GREATER 4.9)
option(DFPLEX_IXW "Use IXWebSocket instead of websocketpp" ON)
else()
# GCC 4.9 is not compatible with IXWebSockets
# GCC 4.9 is not compatible with IXWebSockets
option(DFPLEX_IXW "Use IXWebSocket instead of websocketpp" OFF)
endif()
else()
Expand Down

0 comments on commit 37f0cbd

Please sign in to comment.