Update README, todos, and project structre

lemeryfertitta · Nov 17, 2023 · 679b2c8 · 679b2c8
1 parent 96a5f44
commit 679b2c8
Show file tree

Hide file tree

Showing 10 changed files with 29 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,23 @@
 # Historian - Game Recorder for Colonist.io
 
-Historian is a browser extension which allows for easy capture of Colonist.io games.
+Historian is a fan-made browser extension and web app which allow for easy capture and replay of Colonist.io games.
+
+![](media/historian.gif)
+
+## Installation
+
+Chrome is currently the only browser supported for this extension. Contributions to assist with porting the extension to other browsers are welcome!
+
+The Chrome extension is currently pending review by Google. In the meantime, the Chrome extension must be installed manually. To do so, [download](https://github.com/lemeryfertitta/ColonyHistorian/archive/refs/heads/main.zip) or clone this repository.
+
+Navigate to [chrome://extensions](chrome://extensions) and click "Load Unpacked" at the top left corner of the screen. Then simply navigate to and select the `ColonyHistorian` directory that you've downloaded. The extension should start working immediately upon your next visit to Colonist.io.
+
+## Usage
+
+The extension will automatically download your Colonist.io games after it is installed. The extension will only work if it is active during the initial connection to Colonist.io and if a new game is started, so make sure to refresh and start a new game to start saving logs. The files will be saved as `historian-<game-id>.json` in your default downloads location upon completion of a game. If your connection is broken or refreshed during the game, the replay will not be saved.
+
+To replay a game, simply navigate to https://lemeryfertitta.github.io/ColonyHistorian/ or open the `index.html` file in your browser and upload the file you'd like to replay.
+
+## Bug Reports and Feature Requests
+
+Please use the [Github issue tracker](https://github.com/lemeryfertitta/ColonyHistorian/issues) to submit a bug report or feature request.
diff --git a/TODO.md b/TODO.md
@@ -1,14 +1,6 @@
 # TODO List
 
-## Pre-release
-
-- Release chrome extension
-- Make a gif of usage
-- Update README with usage instructions, gif
-- Post about project on reddit and discord
-
-## Post-release
-
+- Move TODOs to Github issues
 - Make distinction between last placement turn and first dice roll, and 4th players placement turns
 - Improve road appearance (maybe gradients or use road icons)
 - Game states (esp. dice frequency, robber info)
@@ -20,3 +12,5 @@
 - Improve performance when rapidly scrolling through turns
 - Get extension to work in firefox (may have to figure out how to do extension without MAIN world directive)
 - Consider hosting log storage and replayer
+- Handle connection drop
+- Link to chrome extension after review complete
diff --git a/index.html b/index.html
@@ -3,7 +3,7 @@
   <head>
     <meta charset="UTF-8" />
     <title>Colony Historian</title>
-    <link rel="icon" href="icon/icon.svg" type="image/x-icon" />
+    <link rel="icon" href="media/icons/icon.svg" type="image/x-icon" />
   </head>
 
   <body>

diff --git a/manifest.json b/manifest.json
@@ -4,9 +4,9 @@
   "version": "1.0",
   "manifest_version": 3,
   "icons": {
-    "16": "icon/icon_16.png",
-    "48": "icon/icon_48.png",
-    "128": "icon/icon_128.png"
+    "16": "media/icons/icon_16.png",
+    "48": "media/icons/icon_48.png",
+    "128": "media/icons/icon_128.png"
   },
   "content_scripts": [
     {

diff --git a/media/historian.gif b/media/historian.gif
diff --git a/icon/icon.svg → media/icons/icon.svg b/icon/icon.svg → media/icons/icon.svg
diff --git a/icon/icon_128.png → media/icons/icon_128.png b/icon/icon_128.png → media/icons/icon_128.png
diff --git a/icon/icon_16.png → media/icons/icon_16.png b/icon/icon_16.png → media/icons/icon_16.png
diff --git a/icon/icon_48.png → media/icons/icon_48.png b/icon/icon_48.png → media/icons/icon_48.png
diff --git a/release_extension.py b/release_extension.py
@@ -13,7 +13,7 @@ def zip_extension():
     with zipfile.ZipFile(f"historian-{get_version()}.zip", "w") as zipf:
         zipf.write("manifest.json")
         zipf.write("src/recorder/recorder.js")
-        for root, _, files in os.walk("icon"):
+        for root, _, files in os.walk("media/icons"):
             for file in files:
                 zipf.write(os.path.join(root, file))