Meta: README.md and LICENSE

2 files changed, 132 insertions, 0 deletions

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..e7e2f13
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Frederick Yin
+
+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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..30855e7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,110 @@
+# One tøp song — A web game
+
+You can play it here: [One tøp song](https://fkfd.me/toys/one_top_song/)
+
+## Synopsis
+
+__1005__. That's how many words there are that appear in only one twenty
+øne piløts song, give or take (see next section for more details). From
+obvious ones like "stressed", to words that you swear you heard elsewhere
+but aren't such as "went".
+
+In this game you will be shown one word from the list, and asked to answer
+which song is it from. (Feel free not to answer 🙂)
+
+## Where do the words come from?
+
+I downloaded lyrics to all tøp songs from azlyrics.com with Python (which
+in retrospect seemed like a violation of their terms of service), saved
+them in .txt files, and wrote another Python script to locate words that
+appear in only one song.
+
+If inflections of the same word are found in any other song, all of them,
+including the original form, are removed (with a third Python script of
+course), unless they are semantically or phonetically distinguishable. The
+criteria for phonetically indistinguishable inflections are -s, -es, -d,
+-ed and -ing. However, if they only appear in one song, all inflections
+are preserved.
+
+For example, "sons" only appears in Addict With A Pen ("I haven't been the
+best of sons"), but because "son" appears in Taxi Cab, Clear, Polarize and
+No Chances, "sons" is removed from the dataset. "Weathered" (Chlorine) is
+semantically distinguishable from "weather" (Good Day, Migraine), so it is
+preserved. "Buy" (House of Gold) is phonetically distinguishable from
+"bought" (Car Radio, Levitate), so it is also preserved.
+
+Also, words that are just track titles (e.g. heavydirtysoul) are removed.
+
+For more information please consult files in `data/`.
+
+## How to play?
+
+A word is shown above the textbox, where you try to guess which song the
+word came from. The textbox will guess what you mean (for example, typing
+"ho" narrows down the possibilities to House Of Gold, HOTY and Hometown).
+
+Press Enter to select the first song listed (it should work on mobile
+keyboards too, just beware of autocorrect), or just click on any of them.
+
+Click Next to see a new, random word. Click Hint to reveal which album the
+song is in (Self-Titled, RaB, RaB & Vessel, Vessel, Blurryface, Trench,
+SAI, Single). Click Show Answer to reveal everything, including album,
+track, and the line(s) the word is taken from.
+
+## List of songs included
+
+- All of Self-Titled
+- All of Regional at Best
+- All of Vessel
+- All of Blurryface
+- All of Trench
+- All of Scaled And Icy
+- Time To Say Goodbye
+- Cancer
+- Heathens
+- Level Of Concern
+- Christmas Saves The Year
+
+These songs, however, are not included:
+
+- Any of No Phun Intended
+- Coconut Sharks in the Water
+- "Mexico City Song", which apparently exists according to azlyrics but I never heard
+- Can't Help Falling In Love (Elvis cover)
+- Any cover other than Cancer
+- The Hype (Berlin)
+- Level Of Concern (live from outside)
+
+## Disclaimer
+
+"One tøp song" is made by fkfd entirely for entertainment purposes. I make
+absolutely no warranty. It is not a tool for gatekeeping. Not knowing
+lyrics to some tøp songs does not make you a fake fan (not knowing all,
+however, does). It is not a tool for scientific purposes either.
+
+This website collects absolutely no data. I do not sell your information
+in those terms of agreement. No cookies either. Well in theory I could see
+your IP in the server logs, but I never bothered to check.
+
+Twenty One Pilots and/or Fueled By Ramen are copyright owners of both the
+lyrics and the album covers. Fair use or something I'm not American.
+
+This is not legally binding, but I feel I have the obligation to say this:
+pet cheetah. Thank you.
+
+## Licensing
+
+The following files are subject to the MIT license:
+
+- index.html
+- index.css
+- index.js
+
+All Python files in `data/` are in the public domain.
+
+`data/1000` is under CC BY-SA.
+
+I don't have any lawyer friends but what I know is no one can own
+non-trademarked words in the English language. On this ground, all words
+in the datasets are in the public domain, but the lyrics in the form of
+full lines are owned by TØP and/or FBR.