Archive commit

.gitattributes

@@ -0,0 +1,8 @@
+*.png filter=lfs diff=lfs merge=lfs -text
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.webm filter=lfs diff=lfs merge=lfs -text
+*.mp3 filter=lfs diff=lfs merge=lfs -text
+*.psd filter=lfs diff=lfs merge=lfs -text
+*.gif filter=lfs diff=lfs merge=lfs -text
+*.ico filter=lfs diff=lfs merge=lfs -text

CHANGELOG.md

@@ -0,0 +1,520 @@
+#### v0.53.0
+- Added custom servers (about page)
+- Added export option for ponies (character page)
+- Added editing house floor tiles
+- Added more placeable object for the house
+- Added way to cycle backwards through item list by using <kbd>Shift</kbd> + <kbd>E</kbd> while holding the hammer tool
+- Added <code>/lockhouse</code> and <code>/unlockhouse</code> commands for preventing other people from modifying the house
+- Added <code>/removetoolbox</code> and <code>/restoretoolbox</code> commands for removing and restoring toolbox object from house map
+- Added switching placeable items and tiles by using mouse wheel
+- Added switching tools using <kbd>Shift</kbd> + scroll wheel when you're inside the house
+- Unlocked other objects in the house for removing
+- Unlocked walls in front of windows from being placed
+- Increased house object limit
+- Fixed issues with house map saving using <code>/savehouse</code> command
+- Fixed being able to plain object in house behind wall
+
+#### v0.52.0
+- Added cave/mines map
+- Added 2 new cave/mine sound tracks
+- Added new cave/mine objects and decorations
+- Added bunnies around the map
+- Added direction signs
+- Added pickable ropes in mines
+- Added building and removing walls in party house using saw tool
+- Added removing furniture in party house using broom tool
+- Added placing furniture in party house using hammer tool
+- Added "Switch tool" and "Switch item to place" actions
+- Added carrot field in top right corner of the map
+- Added more fruits to fruit box
+- Added sort tags to character descriptions (the same names are sorted by description)
+- Added character description help tooltip
+- Added some new emotes
+- Improved sorting of character list
+- Improved tags dropdown
+
+#### v0.51.2
+- Added character descriptions and tags
+- Added song switching when changing maps
+- Fixed performance issues with login server
+- Fixed issues with rendering avatars on friend list
+- Fixed issues with displaying load error messages
+- Improved character searching on character list
+- Improved map compression
+
+#### v0.51.1
+- Fixed multiple issues with party maps
+- Fixed being able to permanently hide your own character
+
+#### v0.51.0
+- Added party house on party island
+- Added 2 new house sound tracks
+- Added new objects for party house
+- Added magic action and <code>/magic</code> command (usable by unicorns)
+- Added "darken locked outlines" option to character editor
+- Added permanent hides
+- Added list of permanent hides to account settings
+- Changed ignore party invites to not apply to friends
+- Updated look of cliffs
+- Fixed socks resetting if only back leg socks are set
+- Fixed issues with invisible or duplicate player character
+- Fixed issues with blurring of action buttons when action bar is scrolled
+- Fixed issues with collision on boat bridge
+- Fixed some cyrillic characters not working for expressions correctly
+- Fixed rendering issues in character editor
+- Fixed issues with water animation when holding lantern
+- Fixed some rock animations overlapping with terrain
+- Fixed apples spawning on water
+
+#### v0.50.0
+- Combined portuguese and spanish safe servers into one
+- Added new 18+ russian server
+- Added swimming
+- Added new sock patterns
+- Added setting separate accessory for each leg
+- Added switch for disabling outline darkening
+- Added customizable eyelash color
+- Added character count to character selection list
+- Added pickable flower on party island
+- Added rocks in water
+- Added benches
+- Added smaller island bit
+- Added box of fruits on party island
+- Added rare pickable pear and banana
+- Increased party size to 30
+- Increased friend limit to 100
+- Fixed not updating last used pony when using swap pony option
+- Fixed game update issues after server restart
+
+#### v0.49.0
+- Added new 18+ non-ERP server
+- Added new Safe Spanish server
+- Added new Safe Portuguese server
+- Added character swapping
+- Added online/offline status switch to account dropdown
+- Added scrolling of action bar on PC using mouse wheel
+- Added setting separate eye white color for each eye
+- Increased base character limit to 200 and supporter character limits to +200/+300/+450
+- Fixed issues with game joining when spawning at the edge of the map
+- Fixed gamepad X button causing pony to sit down
+- Fixed player hiding getting reset on server restart
+- Fixed connection issues in some cases
+- Improved game performance
+
+#### v0.48.2
+- Added flying over cliffs, fences and some other objects
+- Increased hide limit to 1000
+- Fixed issues with collision detection
+- Fixed issues with switching maps
+- Fixed issues with grass on party island map
+
+#### v0.48.1
+- Added toy stash and item stash to party island
+- Increased party size to 20
+- Fixed issues with server restart
+- Fixed issues with issues with party island map in some cases
+
+#### v0.48.0
+- Added harbor
+- Added party island map
+- Added party island music tracks
+- Added <b>bright night</b> settings option, that makes game brighter during in-game night
+- Added past supporter status
+- Added extra pony slots for past supporters
+- Fixed issues with collision inconsistencies
+- Fixed friend tag and name color showing even when switched to "show as offline"
+- Fixed commands not working in whispers
+- Fixed camera issue after joining to the game
+- Fixed <kbd>-</kbd> and <kbd>=</kbd> shortcuts not working on Firefox
+- Fixed issues when selecting player from chatlog
+- Fixed shortcut for hiding public chat
+- Improved displaying party and whisper commands in chatlog
+- Improved collision handling
+- Improved game performance
+- Increased friend limit
+- Updated swear filters
+
+#### v0.47.0
+- Added friend list
+- Added whispers (private messages)
+- Added <code>/w &lt;name&gt;</code> and <code>/whisper &lt;name&gt;</code> command
+- Added <code>/r</code> and <code>/reply</code> command
+- Added "Ignore friend requests" settings option
+- Added "Only allow whispers from friends" settings option
+- Fixed issues with duplicate characters in certain cases
+- Fixed issues with game not rendering after switching apps or tabs in some cases
+- Fixed game loading performance issues
+- Fixed account name not saving properly when entering name of maximum allowed length
+- Improved performance
+- Improved networking
+- Improved server performance
+- Updated swear filters
+
+#### v0.46.6
+- Reverted performance improvement leading to issues with sprite rendering on some browsers
+
+#### v0.46.5
+- Moved rose sign
+- Fixed some commands not working properly when using uppercase letters
+- Fixed issues with map regions not loading correctly in certain cases
+- Fixed issues with map not loading in certain cases
+- Fixed server-side performance issues
+- Fixed issues with AFK check
+- Fixed issues with colors missing on held items in certain cases
+- Updated swear filters
+
+#### v0.46.4
+- Fixed issues with incorrect color for chat type indicator in certain cases
+- Fixed issues with joining after disconnect resulting in missing or duplicated characters
+- Fixed issues with error reporting
+- Improved some settings labels
+- Improved server performance
+
+#### v0.46.3
+- Changed longer hide to 10 days instead of 7
+- Increased hide limit to 25
+- Updated swear filters
+- Fixed critical server-side issues
+
+#### v0.46.2
+- Fixed items spawning on cliffs
+- Fixed issues with date of birth month list
+- Updated swear filters
+
+#### v0.46.1
+- Fixed issues with collisions
+- Fixed issues with disappearing player character in certain cases
+- Fixed items spawning on cliffs
+- Fixed some misplaced objects
+- Fixed some issues with object sorting
+
+#### v0.46.0
+- Increased map size
+- Added new locations to the map
+- Added new plants
+- Increased party size limit to 10 players
+- Increased hide limit to 20
+- Fixed multiple issues with party UI
+- Fixed issues with music playback
+- Fixed issues with disappearing player character in certain cases
+- Fixed missing range limitation for changing tiles
+- Improved server performance
+- Improved rendering reliability and performance
+- Updated swear filters
+- Updated server infrastructure
+
+#### v0.45.3
+- Fixed issues with saving account settings in some cases
+- Fixed server performance issues
+- Fixed some styling issues
+- Updated swear filters
+- Improved graphics performance
+- Improved server logging and performance analysis tools
+
+#### v0.45.2
+- Added 25 more pony slots for all players
+- Removed collectable eggs
+- Fixed graphics memory leak issue
+- Fixed graphics initialization issues in certain cases
+- Fixed performance issues when joining to the game
+- Improved networking performance
+
+#### v0.45.1
+- Added egg donation barrel
+- Fixed issues when saving settings in certain cases
+- Fixed issues with action bar on desktop PCs with touchscreens
+- Fixed disconnect issues in some cases
+- Fixed broken link in about page
+
+#### v0.45.0
+- Added collectable eggs
+- Added egg emoji
+- Added <code>/eggs</code> command
+- Added eggs command action
+- Added keyboard shortcut <kbd>F3</kbd> for toggling public chat
+- Fixed custom filters not working for player names
+- Fixed styling issues on Yandex browser
+- Fixed tongue not visible on expression action buttons
+- Reduced memory usage
+- Improved graphics resource allocation management
+- Improved memory usage for graphics resources
+- Improved chatlog performance
+
+#### v0.44.2
+-	Fixed actions modal styling issues on Internet explorer
+- Fixed error when running out of memory in some cases
+- Fixed not being able to join server in some cases
+
+#### v0.44.1
+- Changed command actions to use last used chat type (party/public)
+- Fixed actions modal scrolling by itself on mobile
+- Fixed some closed eyes not counted correctly as closed for sleeping emotes
+
+#### v0.44.0
+- Added action bar
+- Added action bar customization via "Actions" option in in-game settings dropdown
+- Fixed issues with showing incorrect party state after disconnect in certain cases
+
+#### v0.43.2
+- Added filters section to in-game settings
+- Added custom chat filter to in-game settings
+- Improved rendering performance
+- Fixed chatlog range indicator showing incorrectly in some cases
+- Fixed incorrect errors when failed to initialize graphics device
+- Fixed connection issues when cancelling joining to the game
+- Updated swear filters
+
+#### v0.43.1
+- Added ignore public chat option to in-game settings
+- Added button shortcut for opening chat on controller
+- Added date of birth field to account settings
+- Changed eyes when using uppercase Q letters in expressions <code>QcQ</code>
+- Changed character name validation
+- Improved camera shifting when opening mobile keyboard
+- Improved some letters in pixel font
+- Fixed issues when mobile keyboard is opened
+- Fixed incorrect error messages for party invites in some cases
+- Updated swear filters
+
+#### v0.43.0
+- Added new manes
+- Added chatlog range setting
+- Added fps counter (option in settings)
+- Changed "see through objects" and "chatlog opacity" settings to be saved on server
+- Changed night to be lighter on low graphics settings to compensate for missing lights
+- Improved party invite error messages
+- Updated map with new flower and clover patches
+- Updated swear filters
+- Removed some expression combinations from PG rated servers
+- Fixed command messages in party chat being colored white instead of yellow
+- Fixed issues with part of game screen being outside the screen bounds on mobile devices in some cases
+- Fixed issues with pixel scaling on low graphics mode
+- Fixed issues with game screen turning green or black
+- Fixed issues with game loading
+- Fixed issues with music playing before the game loads
+- Fixed issue with reloading game in some cases
+- Fixed styling issues
+
+#### v0.42.4
+- Changed season to spring
+- Updated swear filters
+- Fixed some issues with account alerts
+
+#### v0.42.3
+- Added <code>:thinking:</code> emoji
+- Added account alerts for notifying players of account related issues
+- Removed some expression combinations from PG rated servers
+- Updated swear filters
+- Fixed graphical glitch with some expressions when using beak muzzle option
+- Fixed sign-in error showing off-screen on some devices
+- Fixed some disconnect issues
+- Improved performance
+
+#### v0.42.2
+- Fixed issue with game breaking in some cases when the connection is interrupted
+
+#### v0.42.1
+-	Fixed issues with color pickers on some mobile devices
+
+#### v0.42.0
+- Added rose sign
+- Added <code>/love</code>, <code>/<3</code> command
+- Updated common issues help section
+- Updated in-game settings window
+- Fixed some issues with game screen positioning on mobile devices
+- Fixed some issues with chatlog scrolling
+- Fixed issues with switching chat mode
+
+#### v0.41.0
+- Added new facial hair styles and patterns
+- Added cookie stand
+- Fixed issue with chatlog tab switching on Firefox
+- Fixed issue with bats getting stuck when returning to trees
+- Fixed issue with characters with no wings appear to hover above ground in certain cases
+- Fixed issue with delay when joining to the game
+- Fixed errors when using remote buttons while playing the game
+- Fixed some off-screen messages appearing in chatlog
+- Fixed some styling issues
+
+#### v0.40.1
+- Remove loading performance optimization due to Yandex browser bug
+
+#### v0.40.0
+- Added chatlog
+- Added chatlog settings
+- Added settings for walking by default
+- Fixed graphical glitch when booping while sitting
+- Fixed issues with critter movement
+- Fixed being able to be hidden by yourself in certain situations
+- Fixed incorrect error message displayed in certain situations
+- Improved game loading performance
+
+#### v0.39.4
+- Added number in queue indicator when joining to the game takes longer than a second
+- Fixed issue with game not loading when graphics initialization takes longer than connecting to the server
+- Fixed issues with gamepad dpad moving the character
+- Fixed issues with iPad keyboards where each key would only work once, the keys will still get stuck occasionally due to iOS bug, we recommend to use arrow keys for movement instead of WASD keys.
+
+#### v0.39.3
+- Fixed issues with sending long messages on Edge and Internet Explorer browsers
+
+#### v0.39.2
+- Removed Xmas decorations
+- Changed support contact email
+- Fixed some issues with disconnects
+- Fixed party chat messages visible when party member is on another map
+- Improved networking performance
+- Improved server performance
+
+#### v0.39.1
+- Added gift donation spot where you can donate gifts and reduce your gift count
+- Added additional restart buttons to avoid getting stuck in game updating state
+- Added remembering of <code>/s1</code>, <code>/s2</code> and <code>/s3</code> chat mode for next message
+- Added more logging for analyzing sign-in issues
+- Fixed issues with mobile keyboard when the game is installed to home screen
+- Fixed issues with game updating
+- Fixed issues with missing files during game update process
+- Fixed focusing pony name input field on mobile devices causing mobile keyboard to open
+- Fixed being able to see lantern lights of lanterns held by hidden players in some cases
+
+#### v0.39.0
+- Added xmas decorations
+- Added gifts with collectable toys (use <kbd>E</kbd> or <code>/open</code> command or <em>gift button</em> on mobile to open the gift)
+- Added <code>/droptoy</code> command for getting rid of toy on your head
+- Added <code>/toys</code> for listing amount of collected toys
+- Added candy/cookie stands
+- Added picking up apples and oranges
+- Added set of most common Chinese characters
+- Added Japanese Kanji characters
+- Added cookie emoji
+- Changed plushie sign to toy stash (keeps all your collected toys)
+- Changed unicode symbol assigned for some emoji characters
+- Fixed some issues with updating the game
+- Fixed some issues with height difference when standing on ice
+- Improved rendering performance
+
+#### v0.38.0
+- Added winter environment details
+- Changed season to winter
+- Fixed some performance issues
+
+#### v0.37.3
+- Fixed issues with character selection list on mobile devices
+- Fixed issues with keyboard on mobile devices
+
+#### v0.37.2
+- Fixed issues with character selection
+- Fixed issues when using mouse with more than 3 buttons
+
+#### v0.37.1
+- Added <code>/leave</code> command
+- Removed Halloween decorations
+- Fixed some duplicate objects on the map
+- Fixed issues with cloudflare verification window not working properly
+- Fixed issues with some sprites
+- Fixed issues with opening mobile keyboard on some devices
+- Fixed issues with drawing lights in certain cases
+- Improved networking performance
+- Improved server performance
+
+#### v0.37.0
+- Added 2 new music tracks
+- Added new head, face, neck, chest and back accessories
+- Added new sleeve options for chest accessories
+- Added new manes
+- Added new tails
+- Added new face markings
+- Added new horn and horn patterns
+- Added new eyelashes
+- Added new ears
+- Added new hooves
+- Added ear patterns
+- Added pants back accessory
+- Added Halloween decorations
+- Added spooks
+- Changed google sign-in icon
+- Updated team and contributors lists
+- Updated head accessory positions for each mane
+- Fixed issues with install button
+- Fixed issues with mobile keyboard in app mode
+- Fixed issues with map loading in certain cases
+- Fixed some sprite layering issues
+- Fixed some site links not working in certain cases
+- Fixed cutting off some pixels when exporting fly animation as PNG
+- Fixed color in butt mark editor changing when switching tabs
+- Improved rendering performance
+
+#### v0.36.1
+- Updated facebook sign-in
+- Fixed some lighting issues
+- Improved lighting performance
+
+#### v0.36.0
+- Changed season to autumn
+- Increased map size
+- Added new locations and road system
+- Added some rule explanations to <em>Common issues</em> section on <em>Help</em> page
+- Improved lighting engine
+- Fixed issues with character not shown as flying in some cases
+- Fixed issues with updating Patreon data
+- Fixed issues with game update process
+- Fixed issues with loosing item counters when merging accounts in certain situations
+- Fixed issues with getting kicked out of the party in certain situations
+- Fixed incorrect symbol used for <code>:trans:</code> emoji
+
+#### v0.35.7
+- Added warning message for some outdated browsers
+- Improved networking performance
+- Fixed "Um." and "Um-" text causing expression to change
+- Fixed some issues with character selection
+- Fixed some issues with name display
+- Fixed issues with Cloudflare reloading
+
+#### v0.35.6
+- Improved server performance
+- Improved network usage
+
+#### v0.35.5
+- Added option to install the game on android devices
+- Improved startup performance
+- Improved server performance
+- Fixed party list covering chat buttons in some cases on small screens
+- Fixed issues with experimental progressive map loading
+
+#### v0.35.4
+- Added experimental progressive map loading
+- Added power saving option to settings
+- Improved performance of map loading
+- Reworked internal server communication
+- Fixed layering issues with some accessories
+- Fixed incorrect hitbox for flying ponies
+- Fixed issues with drawing ponies at the edge of the screen
+- Fixed some unhelpful error messages
+- Fixed some words interpreted as expressions
+- Fixed some issues with movement on slow networks
+- Fixed some issues with boop animation when lying down
+- Fixed some issues with error reporting
+
+#### v0.35.3
+- Added <code>b.d</code> / <code>6.6</code> expression
+- Added fly animation to character editor
+- Improved visibility checking
+- Improved networking performance
+- Fixed issue with disappearing party member portraits
+- Fixed server-side performance issues
+- Fixed update notification not showing when joined during an update
+- Fixed server shutdown issues
+- Fixed incorrect hitbox for flying characters
+- Fixed server-side timing issues
+
+#### v0.35.2
+- Fixed performance issues when a lot of users are joining the server at the same time
+
+#### v0.35.1
+- Fixed performance issues with ignore system and hiding system
+- Fixed performance issues when a lot of users are joining the server at the same time
+
+#### v0.35.0
+- Added flying - <kbd>C</kbd> key or <kbd class="gamepad gamepad-dpad"><div class="dpad-up"></div></kbd> button or <code>/fly</code> command
+- Added booping while flying
+- Added flying above water

LICENSE_ART.txt

@@ -0,0 +1,364 @@
+creator(s):
+	Shino (https://www.deviantart.com/shinodage)
+	ChiraChan (https://www.deviantart.com/chiramii-chan, https://chirachan-art.tumblr.com/)
+	Velenor (https://www.deviantart.com/velenor)
+	ShareMyShipment (https://www.deviantart.com/sharemyshipment)
+	Paulpeoples (https://www.deviantart.com/paulpeopless)
+	Meno (https://www.deviantart.com/menojar)
+	Goodly (https://www.deviantart.com/goodlyay)
+	TioRafaJP (https://www.deviantart.com/tiorafajp, https://www.youtube.com/user/RafaelJP2)
+	CyberPon3 (https://www.deviantart.com/cyberpon3)
+	OtakuAP (https://www.deviantart.com/otakuap)
+	Disastral
+	Velvet-Frost (https://www.deviantart.com/velvet-frost)
+	Jet7Wave (https://www.deviantart.com/jetwave)
+	Lalieri (https://lalieri.tumblr.com/)
+	Ruef-bae (https://www.deviantart.com/ruef-bae)
+	Alchemist3rd
+	Firecracker
+	ZippySqrl (https://www.deviantart.com/zippysqrl)
+	Karnel333
+	Wellfugzee
+	ScribblesHeart (https://www.deviantart.com/scribblesdesu)
+	dsp2003 (https://dsp2003.tumblr.com/, http://www.deviantart.com/dsp2003)
+	MysticBlare (https://twitter.com/MysticBlare)
+	Towmacow Waffles (https://www.deviantart.com/towmacowwaffles)
+	OrchidPony (https://www.deviantart.com/orchidpony)
+	Cherry Cerise (https://www.deviantart.com/cherryceriseart)
+	Radio
+	Ultimate Fluff
+	SC (https://0somecunt0.tumblr.com/tagged/sfw)
+	SailorDolpin (https://vk.com/id324582699)
+	Deeraw (https://www.deviantart.com/deerdraw, https://twitter.com/TheOnlyDeeraw)
+
+
+Creative Commons Attribution-NonCommercial 4.0 International Public
+License
+
+By exercising the Licensed Rights (defined below), You accept and agree
+to be bound by the terms and conditions of this Creative Commons
+Attribution-NonCommercial 4.0 International Public License ("Public
+License"). To the extent this Public License may be interpreted as a
+contract, You are granted the Licensed Rights in consideration of Your
+acceptance of these terms and conditions, and the Licensor grants You
+such rights in consideration of benefits the Licensor receives from
+making the Licensed Material available under these terms and
+conditions.
+
+
+Section 1 -- Definitions.
+
+  a. Adapted Material means material subject to Copyright and Similar
+     Rights that is derived from or based upon the Licensed Material
+     and in which the Licensed Material is translated, altered,
+     arranged, transformed, or otherwise modified in a manner requiring
+     permission under the Copyright and Similar Rights held by the
+     Licensor. For purposes of this Public License, where the Licensed
+     Material is a musical work, performance, or sound recording,
+     Adapted Material is always produced where the Licensed Material is
+     synched in timed relation with a moving image.
+
+  b. Adapter's License means the license You apply to Your Copyright
+     and Similar Rights in Your contributions to Adapted Material in
+     accordance with the terms and conditions of this Public License.
+
+  c. Copyright and Similar Rights means copyright and/or similar rights
+     closely related to copyright including, without limitation,
+     performance, broadcast, sound recording, and Sui Generis Database
+     Rights, without regard to how the rights are labeled or
+     categorized. For purposes of this Public License, the rights
+     specified in Section 2(b)(1)-(2) are not Copyright and Similar
+     Rights.
+  d. Effective Technological Measures means those measures that, in the
+     absence of proper authority, may not be circumvented under laws
+     fulfilling obligations under Article 11 of the WIPO Copyright
+     Treaty adopted on December 20, 1996, and/or similar international
+     agreements.
+
+  e. Exceptions and Limitations means fair use, fair dealing, and/or
+     any other exception or limitation to Copyright and Similar Rights
+     that applies to Your use of the Licensed Material.
+
+  f. Licensed Material means the artistic or literary work, database,
+     or other material to which the Licensor applied this Public
+     License.
+
+  g. Licensed Rights means the rights granted to You subject to the
+     terms and conditions of this Public License, which are limited to
+     all Copyright and Similar Rights that apply to Your use of the
+     Licensed Material and that the Licensor has authority to license.
+
+  h. Licensor means the individual(s) or entity(ies) granting rights
+     under this Public License.
+
+  i. NonCommercial means not primarily intended for or directed towards
+     commercial advantage or monetary compensation. For purposes of
+     this Public License, the exchange of the Licensed Material for
+     other material subject to Copyright and Similar Rights by digital
+     file-sharing or similar means is NonCommercial provided there is
+     no payment of monetary compensation in connection with the
+     exchange.
+
+  j. Share means to provide material to the public by any means or
+     process that requires permission under the Licensed Rights, such
+     as reproduction, public display, public performance, distribution,
+     dissemination, communication, or importation, and to make material
+     available to the public including in ways that members of the
+     public may access the material from a place and at a time
+     individually chosen by them.
+
+  k. Sui Generis Database Rights means rights other than copyright
+     resulting from Directive 96/9/EC of the European Parliament and of
+     the Council of 11 March 1996 on the legal protection of databases,
+     as amended and/or succeeded, as well as other essentially
+     equivalent rights anywhere in the world.
+
+  l. You means the individual or entity exercising the Licensed Rights
+     under this Public License. Your has a corresponding meaning.
+
+
+Section 2 -- Scope.
+
+  a. License grant.
+
+       1. Subject to the terms and conditions of this Public License,
+          the Licensor hereby grants You a worldwide, royalty-free,
+          non-sublicensable, non-exclusive, irrevocable license to
+          exercise the Licensed Rights in the Licensed Material to:
+
+            a. reproduce and Share the Licensed Material, in whole or
+               in part, for NonCommercial purposes only; and
+
+            b. produce, reproduce, and Share Adapted Material for
+               NonCommercial purposes only.
+
+       2. Exceptions and Limitations. For the avoidance of doubt, where
+          Exceptions and Limitations apply to Your use, this Public
+          License does not apply, and You do not need to comply with
+          its terms and conditions.
+
+       3. Term. The term of this Public License is specified in Section
+          6(a).
+
+       4. Media and formats; technical modifications allowed. The
+          Licensor authorizes You to exercise the Licensed Rights in
+          all media and formats whether now known or hereafter created,
+          and to make technical modifications necessary to do so. The
+          Licensor waives and/or agrees not to assert any right or
+          authority to forbid You from making technical modifications
+          necessary to exercise the Licensed Rights, including
+          technical modifications necessary to circumvent Effective
+          Technological Measures. For purposes of this Public License,
+          simply making modifications authorized by this Section 2(a)
+          (4) never produces Adapted Material.
+
+       5. Downstream recipients.
+
+            a. Offer from the Licensor -- Licensed Material. Every
+               recipient of the Licensed Material automatically
+               receives an offer from the Licensor to exercise the
+               Licensed Rights under the terms and conditions of this
+               Public License.
+
+            b. No downstream restrictions. You may not offer or impose
+               any additional or different terms or conditions on, or
+               apply any Effective Technological Measures to, the
+               Licensed Material if doing so restricts exercise of the
+               Licensed Rights by any recipient of the Licensed
+               Material.
+
+       6. No endorsement. Nothing in this Public License constitutes or
+          may be construed as permission to assert or imply that You
+          are, or that Your use of the Licensed Material is, connected
+          with, or sponsored, endorsed, or granted official status by,
+          the Licensor or others designated to receive attribution as
+          provided in Section 3(a)(1)(A)(i).
+
+  b. Other rights.
+
+       1. Moral rights, such as the right of integrity, are not
+          licensed under this Public License, nor are publicity,
+          privacy, and/or other similar personality rights; however, to
+          the extent possible, the Licensor waives and/or agrees not to
+          assert any such rights held by the Licensor to the limited
+          extent necessary to allow You to exercise the Licensed
+          Rights, but not otherwise.
+
+       2. Patent and trademark rights are not licensed under this
+          Public License.
+
+       3. To the extent possible, the Licensor waives any right to
+          collect royalties from You for the exercise of the Licensed
+          Rights, whether directly or through a collecting society
+          under any voluntary or waivable statutory or compulsory
+          licensing scheme. In all other cases the Licensor expressly
+          reserves any right to collect such royalties, including when
+          the Licensed Material is used other than for NonCommercial
+          purposes.
+
+
+Section 3 -- License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the
+following conditions.
+
+  a. Attribution.
+
+       1. If You Share the Licensed Material (including in modified
+          form), You must:
+
+            a. retain the following if it is supplied by the Licensor
+               with the Licensed Material:
+
+                 i. identification of the creator(s) of the Licensed
+                    Material and any others designated to receive
+                    attribution, in any reasonable manner requested by
+                    the Licensor (including by pseudonym if
+                    designated);
+
+                ii. a copyright notice;
+
+               iii. a notice that refers to this Public License;
+
+                iv. a notice that refers to the disclaimer of
+                    warranties;
+
+                 v. a URI or hyperlink to the Licensed Material to the
+                    extent reasonably practicable;
+
+            b. indicate if You modified the Licensed Material and
+               retain an indication of any previous modifications; and
+
+            c. indicate the Licensed Material is licensed under this
+               Public License, and include the text of, or the URI or
+               hyperlink to, this Public License.
+
+       2. You may satisfy the conditions in Section 3(a)(1) in any
+          reasonable manner based on the medium, means, and context in
+          which You Share the Licensed Material. For example, it may be
+          reasonable to satisfy the conditions by providing a URI or
+          hyperlink to a resource that includes the required
+          information.
+
+       3. If requested by the Licensor, You must remove any of the
+          information required by Section 3(a)(1)(A) to the extent
+          reasonably practicable.
+
+       4. If You Share Adapted Material You produce, the Adapter's
+          License You apply must not prevent recipients of the Adapted
+          Material from complying with this Public License.
+
+
+Section 4 -- Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that
+apply to Your use of the Licensed Material:
+
+  a. for the avoidance of doubt, Section 2(a)(1) grants You the right
+     to extract, reuse, reproduce, and Share all or a substantial
+     portion of the contents of the database for NonCommercial purposes
+     only;
+
+  b. if You include all or a substantial portion of the database
+     contents in a database in which You have Sui Generis Database
+     Rights, then the database in which You have Sui Generis Database
+     Rights (but not its individual contents) is Adapted Material; and
+
+  c. You must comply with the conditions in Section 3(a) if You Share
+     all or a substantial portion of the contents of the database.
+
+For the avoidance of doubt, this Section 4 supplements and does not
+replace Your obligations under this Public License where the Licensed
+Rights include other Copyright and Similar Rights.
+
+
+Section 5 -- Disclaimer of Warranties and Limitation of Liability.
+
+  a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
+     EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
+     AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
+     ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
+     IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
+     WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
+     PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
+     ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
+     KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
+     ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
+
+  b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
+     TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
+     NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
+     INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
+     COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
+     USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
+     ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
+     DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
+     IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
+
+  c. The disclaimer of warranties and limitation of liability provided
+     above shall be interpreted in a manner that, to the extent
+     possible, most closely approximates an absolute disclaimer and
+     waiver of all liability.
+
+
+Section 6 -- Term and Termination.
+
+  a. This Public License applies for the term of the Copyright and
+     Similar Rights licensed here. However, if You fail to comply with
+     this Public License, then Your rights under this Public License
+     terminate automatically.
+
+  b. Where Your right to use the Licensed Material has terminated under
+     Section 6(a), it reinstates:
+
+       1. automatically as of the date the violation is cured, provided
+          it is cured within 30 days of Your discovery of the
+          violation; or
+
+       2. upon express reinstatement by the Licensor.
+
+     For the avoidance of doubt, this Section 6(b) does not affect any
+     right the Licensor may have to seek remedies for Your violations
+     of this Public License.
+
+  c. For the avoidance of doubt, the Licensor may also offer the
+     Licensed Material under separate terms or conditions or stop
+     distributing the Licensed Material at any time; however, doing so
+     will not terminate this Public License.
+
+  d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
+     License.
+
+
+Section 7 -- Other Terms and Conditions.
+
+  a. The Licensor shall not be bound by any additional or different
+     terms or conditions communicated by You unless expressly agreed.
+
+  b. Any arrangements, understandings, or agreements regarding the
+     Licensed Material not stated herein are separate from and
+     independent of the terms and conditions of this Public License.
+
+
+Section 8 -- Interpretation.
+
+  a. For the avoidance of doubt, this Public License does not, and
+     shall not be interpreted to, reduce, limit, restrict, or impose
+     conditions on any use of the Licensed Material that could lawfully
+     be made without permission under this Public License.
+
+  b. To the extent possible, if any provision of this Public License is
+     deemed unenforceable, it shall be automatically reformed to the
+     minimum extent necessary to make it enforceable. If the provision
+     cannot be reformed, it shall be severed from this Public License
+     without affecting the enforceability of the remaining terms and
+     conditions.
+
+  c. No term or condition of this Public License will be waived and no
+     failure to comply consented to unless expressly agreed to by the
+     Licensor.
+
+  d. Nothing in this Public License constitutes or may be interpreted
+     as a limitation upon, or waiver of, any privileges and immunities
+     that apply to the Licensor or You, including from the legal
+     processes of any jurisdiction or authority.

LICENSE_CODE.txt

@@ -0,0 +1,22 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.

LICENSE_MUSIC.txt

@@ -0,0 +1,334 @@
+creator(s):
+	Wandering Artist (https://wanderingartist.bandcamp.com/, https://www.youtube.com/user/WanderingArtistMusic)
+
+
+Creative Commons Attribution-NonCommercial 4.0 International Public
+License
+
+By exercising the Licensed Rights (defined below), You accept and agree
+to be bound by the terms and conditions of this Creative Commons
+Attribution-NonCommercial 4.0 International Public License ("Public
+License"). To the extent this Public License may be interpreted as a
+contract, You are granted the Licensed Rights in consideration of Your
+acceptance of these terms and conditions, and the Licensor grants You
+such rights in consideration of benefits the Licensor receives from
+making the Licensed Material available under these terms and
+conditions.
+
+
+Section 1 -- Definitions.
+
+  a. Adapted Material means material subject to Copyright and Similar
+     Rights that is derived from or based upon the Licensed Material
+     and in which the Licensed Material is translated, altered,
+     arranged, transformed, or otherwise modified in a manner requiring
+     permission under the Copyright and Similar Rights held by the
+     Licensor. For purposes of this Public License, where the Licensed
+     Material is a musical work, performance, or sound recording,
+     Adapted Material is always produced where the Licensed Material is
+     synched in timed relation with a moving image.
+
+  b. Adapter's License means the license You apply to Your Copyright
+     and Similar Rights in Your contributions to Adapted Material in
+     accordance with the terms and conditions of this Public License.
+
+  c. Copyright and Similar Rights means copyright and/or similar rights
+     closely related to copyright including, without limitation,
+     performance, broadcast, sound recording, and Sui Generis Database
+     Rights, without regard to how the rights are labeled or
+     categorized. For purposes of this Public License, the rights
+     specified in Section 2(b)(1)-(2) are not Copyright and Similar
+     Rights.
+  d. Effective Technological Measures means those measures that, in the
+     absence of proper authority, may not be circumvented under laws
+     fulfilling obligations under Article 11 of the WIPO Copyright
+     Treaty adopted on December 20, 1996, and/or similar international
+     agreements.
+
+  e. Exceptions and Limitations means fair use, fair dealing, and/or
+     any other exception or limitation to Copyright and Similar Rights
+     that applies to Your use of the Licensed Material.
+
+  f. Licensed Material means the artistic or literary work, database,
+     or other material to which the Licensor applied this Public
+     License.
+
+  g. Licensed Rights means the rights granted to You subject to the
+     terms and conditions of this Public License, which are limited to
+     all Copyright and Similar Rights that apply to Your use of the
+     Licensed Material and that the Licensor has authority to license.
+
+  h. Licensor means the individual(s) or entity(ies) granting rights
+     under this Public License.
+
+  i. NonCommercial means not primarily intended for or directed towards
+     commercial advantage or monetary compensation. For purposes of
+     this Public License, the exchange of the Licensed Material for
+     other material subject to Copyright and Similar Rights by digital
+     file-sharing or similar means is NonCommercial provided there is
+     no payment of monetary compensation in connection with the
+     exchange.
+
+  j. Share means to provide material to the public by any means or
+     process that requires permission under the Licensed Rights, such
+     as reproduction, public display, public performance, distribution,
+     dissemination, communication, or importation, and to make material
+     available to the public including in ways that members of the
+     public may access the material from a place and at a time
+     individually chosen by them.
+
+  k. Sui Generis Database Rights means rights other than copyright
+     resulting from Directive 96/9/EC of the European Parliament and of
+     the Council of 11 March 1996 on the legal protection of databases,
+     as amended and/or succeeded, as well as other essentially
+     equivalent rights anywhere in the world.
+
+  l. You means the individual or entity exercising the Licensed Rights
+     under this Public License. Your has a corresponding meaning.
+
+
+Section 2 -- Scope.
+
+  a. License grant.
+
+       1. Subject to the terms and conditions of this Public License,
+          the Licensor hereby grants You a worldwide, royalty-free,
+          non-sublicensable, non-exclusive, irrevocable license to
+          exercise the Licensed Rights in the Licensed Material to:
+
+            a. reproduce and Share the Licensed Material, in whole or
+               in part, for NonCommercial purposes only; and
+
+            b. produce, reproduce, and Share Adapted Material for
+               NonCommercial purposes only.
+
+       2. Exceptions and Limitations. For the avoidance of doubt, where
+          Exceptions and Limitations apply to Your use, this Public
+          License does not apply, and You do not need to comply with
+          its terms and conditions.
+
+       3. Term. The term of this Public License is specified in Section
+          6(a).
+
+       4. Media and formats; technical modifications allowed. The
+          Licensor authorizes You to exercise the Licensed Rights in
+          all media and formats whether now known or hereafter created,
+          and to make technical modifications necessary to do so. The
+          Licensor waives and/or agrees not to assert any right or
+          authority to forbid You from making technical modifications
+          necessary to exercise the Licensed Rights, including
+          technical modifications necessary to circumvent Effective
+          Technological Measures. For purposes of this Public License,
+          simply making modifications authorized by this Section 2(a)
+          (4) never produces Adapted Material.
+
+       5. Downstream recipients.
+
+            a. Offer from the Licensor -- Licensed Material. Every
+               recipient of the Licensed Material automatically
+               receives an offer from the Licensor to exercise the
+               Licensed Rights under the terms and conditions of this
+               Public License.
+
+            b. No downstream restrictions. You may not offer or impose
+               any additional or different terms or conditions on, or
+               apply any Effective Technological Measures to, the
+               Licensed Material if doing so restricts exercise of the
+               Licensed Rights by any recipient of the Licensed
+               Material.
+
+       6. No endorsement. Nothing in this Public License constitutes or
+          may be construed as permission to assert or imply that You
+          are, or that Your use of the Licensed Material is, connected
+          with, or sponsored, endorsed, or granted official status by,
+          the Licensor or others designated to receive attribution as
+          provided in Section 3(a)(1)(A)(i).
+
+  b. Other rights.
+
+       1. Moral rights, such as the right of integrity, are not
+          licensed under this Public License, nor are publicity,
+          privacy, and/or other similar personality rights; however, to
+          the extent possible, the Licensor waives and/or agrees not to
+          assert any such rights held by the Licensor to the limited
+          extent necessary to allow You to exercise the Licensed
+          Rights, but not otherwise.
+
+       2. Patent and trademark rights are not licensed under this
+          Public License.
+
+       3. To the extent possible, the Licensor waives any right to
+          collect royalties from You for the exercise of the Licensed
+          Rights, whether directly or through a collecting society
+          under any voluntary or waivable statutory or compulsory
+          licensing scheme. In all other cases the Licensor expressly
+          reserves any right to collect such royalties, including when
+          the Licensed Material is used other than for NonCommercial
+          purposes.
+
+
+Section 3 -- License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the
+following conditions.
+
+  a. Attribution.
+
+       1. If You Share the Licensed Material (including in modified
+          form), You must:
+
+            a. retain the following if it is supplied by the Licensor
+               with the Licensed Material:
+
+                 i. identification of the creator(s) of the Licensed
+                    Material and any others designated to receive
+                    attribution, in any reasonable manner requested by
+                    the Licensor (including by pseudonym if
+                    designated);
+
+                ii. a copyright notice;
+
+               iii. a notice that refers to this Public License;
+
+                iv. a notice that refers to the disclaimer of
+                    warranties;
+
+                 v. a URI or hyperlink to the Licensed Material to the
+                    extent reasonably practicable;
+
+            b. indicate if You modified the Licensed Material and
+               retain an indication of any previous modifications; and
+
+            c. indicate the Licensed Material is licensed under this
+               Public License, and include the text of, or the URI or
+               hyperlink to, this Public License.
+
+       2. You may satisfy the conditions in Section 3(a)(1) in any
+          reasonable manner based on the medium, means, and context in
+          which You Share the Licensed Material. For example, it may be
+          reasonable to satisfy the conditions by providing a URI or
+          hyperlink to a resource that includes the required
+          information.
+
+       3. If requested by the Licensor, You must remove any of the
+          information required by Section 3(a)(1)(A) to the extent
+          reasonably practicable.
+
+       4. If You Share Adapted Material You produce, the Adapter's
+          License You apply must not prevent recipients of the Adapted
+          Material from complying with this Public License.
+
+
+Section 4 -- Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that
+apply to Your use of the Licensed Material:
+
+  a. for the avoidance of doubt, Section 2(a)(1) grants You the right
+     to extract, reuse, reproduce, and Share all or a substantial
+     portion of the contents of the database for NonCommercial purposes
+     only;
+
+  b. if You include all or a substantial portion of the database
+     contents in a database in which You have Sui Generis Database
+     Rights, then the database in which You have Sui Generis Database
+     Rights (but not its individual contents) is Adapted Material; and
+
+  c. You must comply with the conditions in Section 3(a) if You Share
+     all or a substantial portion of the contents of the database.
+
+For the avoidance of doubt, this Section 4 supplements and does not
+replace Your obligations under this Public License where the Licensed
+Rights include other Copyright and Similar Rights.
+
+
+Section 5 -- Disclaimer of Warranties and Limitation of Liability.
+
+  a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
+     EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
+     AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
+     ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
+     IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
+     WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
+     PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
+     ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
+     KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
+     ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
+
+  b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
+     TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
+     NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
+     INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
+     COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
+     USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
+     ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
+     DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
+     IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
+
+  c. The disclaimer of warranties and limitation of liability provided
+     above shall be interpreted in a manner that, to the extent
+     possible, most closely approximates an absolute disclaimer and
+     waiver of all liability.
+
+
+Section 6 -- Term and Termination.
+
+  a. This Public License applies for the term of the Copyright and
+     Similar Rights licensed here. However, if You fail to comply with
+     this Public License, then Your rights under this Public License
+     terminate automatically.
+
+  b. Where Your right to use the Licensed Material has terminated under
+     Section 6(a), it reinstates:
+
+       1. automatically as of the date the violation is cured, provided
+          it is cured within 30 days of Your discovery of the
+          violation; or
+
+       2. upon express reinstatement by the Licensor.
+
+     For the avoidance of doubt, this Section 6(b) does not affect any
+     right the Licensor may have to seek remedies for Your violations
+     of this Public License.
+
+  c. For the avoidance of doubt, the Licensor may also offer the
+     Licensed Material under separate terms or conditions or stop
+     distributing the Licensed Material at any time; however, doing so
+     will not terminate this Public License.
+
+  d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
+     License.
+
+
+Section 7 -- Other Terms and Conditions.
+
+  a. The Licensor shall not be bound by any additional or different
+     terms or conditions communicated by You unless expressly agreed.
+
+  b. Any arrangements, understandings, or agreements regarding the
+     Licensed Material not stated herein are separate from and
+     independent of the terms and conditions of this Public License.
+
+
+Section 8 -- Interpretation.
+
+  a. For the avoidance of doubt, this Public License does not, and
+     shall not be interpreted to, reduce, limit, restrict, or impose
+     conditions on any use of the Licensed Material that could lawfully
+     be made without permission under this Public License.
+
+  b. To the extent possible, if any provision of this Public License is
+     deemed unenforceable, it shall be automatically reformed to the
+     minimum extent necessary to make it enforceable. If the provision
+     cannot be reformed, it shall be severed from this Public License
+     without affecting the enforceability of the remaining terms and
+     conditions.
+
+  c. No term or condition of this Public License will be waived and no
+     failure to comply consented to unless expressly agreed to by the
+     Licensor.
+
+  d. Nothing in this Public License constitutes or may be interpreted
+     as a limitation upon, or waiver of, any privileges and immunities
+     that apply to the Licensor or You, including from the legal
+     processes of any jurisdiction or authority.

README.md

@@ -0,0 +1,240 @@
+# Pony Town
+
+A game of ponies building a town
+
+## Prerequisites
+
+* [Node.js](https://nodejs.org/download/release/v9.11.2/) (version 9)
+* [gulp](http://gulpjs.com/) `npm install -g gulp`
+* MongoDB: [download link](https://www.mongodb.com/download-center/community) and [installation instructions](https://docs.mongodb.com/manual/administration/install-community/)
+* [ImageMagick](https://imagemagick.org/script/download.php#windows) (optional, required for generating preview gifs in animation tool)
+
+## Installation
+
+```bash
+npm install
+```
+
+## Setting up Database
+
+- Install MongoDB
+- Start `mongo` from command line (you may need to go to `C:\Program Files\MongoDB\Server\4.0\bin` path on windows to run the command)
+- Type `use your_database_name` to create database
+- Type `db.new_collection.insert({ some_key: "some_value" })` to initialize database
+- Type
+  ```javascript
+  db.createUser(
+    {
+      user: "your_username",
+      pwd: "your_password",
+      roles: [ { role: "readWrite", db: "your_database_name" } ]
+    }
+  )
+  ```
+  to create database user.
+- Type `quit()` to exit mongo
+
+## Setting up OAuth keys
+
+Get OAuth keys for authentication platform of your choice (github, google, twitter, facebook, vkontakte, patreon)
+
+### Github
+
+- Go to https://github.com/settings/developers create new OAuth app.
+- Set authorization callback URL to `http://<your domain>/auth/github/callback` or `http://localhost:8090/auth/github/callback` for localhost server.
+- Add this to `oauth` field in your `config.json`
+
+```json
+"github": {
+  "clientID": "<your_client_id>",
+  "clientSecret": "<your_client_secret>"
+}
+```
+
+### Twitter
+
+- Go to https://developer.twitter.com/en/apps create new app.
+- Set callback URL to `http://<your domain>/auth/twitter/callback` or `http://localhost:8090/auth/twitter/callback` for localhost server.
+- Add this to `oauth` field in your `config.json`
+
+```json
+"twitter": {
+  "consumerKey": "<your_consumer_key>",
+  "consumerSecret": "<your_consumer_secret>"
+}
+```
+
+### Google
+
+- Go to https://console.developers.google.com/apis/dashboard create new project from dropdown at the top, go to credentials and create new entry.
+- Add to Authorized JavaScript origins `http://<your domain>` or `http://localhost:8090/` for localhost server.
+- Add to Authorized redirect URIs `http://<your domain>/auth/google/callback` or `http://localhost:8090/auth/google/callback` for localhost server.
+- Add this to `oauth` field in your `config.json`
+
+```json
+"google": {
+  "clientID": "<your_client_id>",
+  "clientSecret": "<your_client_secret>"
+}
+```
+
+### Facebook
+
+- Go to https://developers.facebook.com/apps/ add a new app.
+- Add "Facebook Login" product to your app
+- Enable "Web OAuth Login"
+- Add `https://<your domain>/auth/facebook/callback` to Valid OAuth Redirect URIs
+- Add this to `oauth` field in your `config.json` (You can find App ID and App Secret in Settings > Basic section)
+
+```json
+"facebook": {
+  "clientID": "<your_app_id>",
+  "clientSecret": "<your_app_secret>",
+  "graphApiVersion": "v3.1"
+}
+```
+
+### VKontakte
+
+- Go to https://vk.com/apps?act=manage and create new app
+- Set Authorized redirect URI to `http://<your domain>/auth/vkontakte/callback` or `http://localhost:8090/auth/vkontakte/callback` for localhost server.
+- Add this to `oauth` field in your `config.json`
+
+```json
+"vkontakte": {
+  "clientID": "<your_app_id>",
+  "clientSecret": "<secure_key>"
+},
+```
+
+### Other
+
+If you want to add other sign-in methods you need to find appropriate [passport](http://www.passportjs.org/) package and add it in `src/ts/server/oauth.ts` and add correct entry in `config.json`.
+
+## Configuration
+
+Add `config.json` file in root directory with following content. You can use `config-template.json` as a starting point for your own config. (do not include comments in your `config.json` file)
+
+```javascript
+{
+  "title": "Pony Town",
+  "twitterLink": "https://twitter.com/<twitter_name>", // optional
+  "contactEmail": "<your_contact_email>",
+  "port": 8090,
+  "host": "http://localhost:8090/",
+  "secret": "<some_random_string_here>",
+  "token": "<some_random_string_here>",
+  "db": "mongodb://<username>:<password>@localhost:27017/<database_name>", // use values you used when setting up database
+  "analytics": { // optional google analytics
+    "trackingID": "<tracking_id>"
+  },
+  "facebookAppId": "<facebook_id>", // optional facebook app link
+  "assetsPath": "<path_to_graphics_assets>", // optional, for asset generation
+  "oauth": {
+		"google": {
+			"clientID": "<CLIENT_ID_HERE>",
+			"clientSecret": "<CLIENT_SECRET_HERE>"
+		}
+    // other oauth entries here
+  },
+  "servers": [
+    {
+      "id": "dev",
+      "port": 8090,
+      "path": "/s00/ws",
+      "local": "localhost:8090",
+      "name": "Dev server",
+      "desc": "Development server",
+      "flag": "test", // optional flag ("test", "star" or space separated list of country flags)
+      "flags": { // optional feature flags
+        "test": true, // test server
+        "objects": true, // in-game editor
+      },
+      "alert": "18+", // optional 18+ alert (also blocks underage players)
+    },
+  ]
+}
+```
+
+## Running
+
+Production environment
+
+```bash
+npm run build
+npm start
+```
+
+Adding/removing roles
+
+```bash
+node cli.js --addrole <account_id> <role>   # roles: superadmin, admin, mod, dev 
+node cli.js --removerole <account_id> <role>
+```
+
+To setup superadmin role use following command
+
+```bash
+node cli.js --addrole <your_account_id> superadmin
+```
+
+Admin panel is accessible at `<base_url>/admin/` (requires admin or superadmin role to access)
+Tools are accessible at `<base_url>/tools/` (only available in dev mode or when started with --tools flag)
+
+Starting as multiple processes
+
+```bash
+node pony-town.js --login                    # login server
+node pony-town.js --game main                # game server 1 ('main' has to match id from config.json)
+node pony-town.js --game safe                # game server 2 ('safe' has to match id from config.json)
+node pony-town.js --admin --standaloneadmin  # admin server
+```
+
+For these to work on the same URL, paths to game servers and admin server need to be bound to correct ports, using http proxy.
+
+It is recommended to run processes with larger memory pool for large user bases (especially admin and game processes), example:
+
+```bash
+node --max_old_space_size=8192 pony-town.js --game main
+```
+
+Beta environment (with dev tools and in-development features)
+
+```bash
+npm run build-beta
+node pony-town.js --login --admin --game --tools --beta
+```
+
+Running in development
+
+```bash
+npm run ts-watch    # terminal 1
+npm run wds         # terminal 2
+gulp dev            # terminal 3
+gulp test           # terminal 4 (optional)
+```
+
+```bash
+gulp dev --sprites  # run with generation of sprite sheets (use src/ts/tools/trigger.txt to trigger sprite generation without restarting gulp)
+gulp dev --test     # run with tests
+gulp dev --coverage # run with tests and code coverage
+```
+
+## Customization
+
+- `package.json` - settings for title and description of the website
+- `assets/images` - logos and team avatars
+- `public/images` - additional logos
+- `public` - privacy policy and terms of service
+- `favicons` - icons
+- `src/ts/common/constants.ts` - global settings
+- `src/ts/server/maps/*` - maps configuration and setup
+- `src/ts/server/start.ts` - world setup
+- `src/ts/components/services/audio.ts` - adding/removing sound tracks
+- `src/ts/client/credits` - credits and contributors
+- `src/style/partials/_variables.scss` - page style configuration
+
+### Custom map introduction
+
+- `src/ts/server/start.ts:35` - adding custom map to the world
+- `src/ts/server/map/customMap.ts` - commented introduction to customizing maps