Update README.md

README.md

@@ -1 +1,29 @@
-# NotPogo
+# Not Pogo
+Not Pogo is a Pogo.com Server Emulator meant to run the older Flash/Java Applets to some degree.
+# Why Does This Exist
+Unfortunately the classic servers for Pogo.com were shutdown a long time ago, and with it went over 150+ legacy games. This exists to get those games working to some degree.
+# `client-props.jsp`
+Unfortunately, all games were entirely configured (layout, asset paths, locale, game parameters) in one single file, `config.txt` or `client-props.jsp`'s response.
+Most games are missing this file, so they will more than likely not work correctly or at all.
+This emulator only exists for those who either:
+* found a `config.txt` file
+* reverse engineered one
+* wants to play the singular game we have the file for (**Perfect Pair Solitaire**)
+* wants to understand how the protocol works so that development can progress
+# How To Use
+Since Pogo still exists today, I'd rather not risk legal issues by distributing game assets (there's a huge asset archive though if you know where to look), so you do need to provide assets.
+All you need to do is create a folder structure like this where you have the server release stored:
+
+TODO - add screenshots for folder structure here
+
+# What Works
+* Game Initialization
+* MoTD ("Welcome to Pogo!" server message)
+* Jackpot Spin Win Condition (requires config in `config.txt` to work, if you don't want this, rebuild the server with winMet always equaling to false in `TCPGameServer.cs`)
+
+# What Doesn't Work
+* Chat
+* 'Who's Here'
+* Pogo Minis
+* Any Tabletop Games (Monopoly, Battleship, Checkers, etc.)
+* Downloadable Games (seperate CDL API)