Hacking3DPrinters · HippoProgrammer · Jun 18, 2024 · Jun 18, 2024 · Jun 18, 2024 · Jun 18, 2024
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -29,6 +29,6 @@ jobs:
         python -m pip install --upgrade pip
         python -m pip install --upgrade pytest
         python -m pip install -r requirements.txt
-    - name: Test with pytest
+    - name: Test with custom test suite
       run: |
         python tests.py
diff --git a/README.md b/README.md
@@ -5,29 +5,70 @@
 
 # Robotic Chess
 
-An chess playing robot, powered by Stockfish.
+An chess playing robot, powered by Stockfish and Octoprint.
 For documentation, see [our wiki](https://github.com/Hacking3DPrinters/robotic-chess/wiki).
 
 ---
 
+## Requirements
+
+### Essentials
+* 3-core CPU and at least 3GB of RAM (theoretically this can run with only 2 cores and 2GB of RAM, but at the risk of crashing / hanging your computer)
+* A Linux-based operating system with sudo OR a Windows 10/11 operating system (more difficult)
+* Python 3.10+ and pip
+* Octoprint server connected to a 3D printer
+* An electromagnet connected to M106/M107 extruder fan control
+
+### Recommended
+* 4-core+ CPU and at least 6GB of RAM
+* Python 3.11+ and pip
+* Knowledge of simple Linux commands
+
+---
+
 ## Installation
 
-### Installation from wheel
+### ~~Installation from wheel (beta for Linux)~~ - SUSPENDED UNTIL FURTHER NOTICE
+
+~~First, visit [our releases page](https://github.com/Hacking3DPrinters/robotic-chess/releases) and download the `.whl` file from the desired version (the 'latest' version is recommended).~~
+
+~~Then, run~~ 
+~~```pip install robotic_chess-0.2.1-py3.whl```~~
+~~(replace 0.2.1 with the version number of your downloaded wheel).~~
+
+~~You must then edit `~/.config/octoprint-cli.ini` and input the server details of your octoprint server.~~
+
+### Installation from source - Linux (recommended for Linux dev builds)
+
+First, clone our repo using `git clone https://github.com/Hacking3DPrinters/robotic-chess.git`, and enter the new directory. 
+Then edit `config.ini` with your server details of the octoprint server.
+
+Then run `python3 setup.py install` to begin setup.
 
-First, visit [our releases page](https://github.com/Hacking3DPrinters/robotic-chess/releases) and download the `.whl` and `requirements.txt` files from the desired version.
+### Installation from source - Windows (recommended for Windows)
 
-Then, run 
-```pip install robotic_chess-0.2.1-py3.whl```
-(replace 0.2.1 with the version number of your downloaded wheel).
+First, download the `Source code (zip)` from our releases page.
 
-Finally, run 
-```pip install -r requirements.txt```
-to install dependencies.
+Unzip it, then edit `config.ini` with your server details of the octoprint server.
 
-THIS DOES NOT INSTALL STOCKFISH OR OCTOPRINT (will be included in the future).
+Then run `python3 setup.py install` to begin setup.
 
-### Installation from source 
+---
+
+## Running
+
+Run `python3 -m robotic_chess`.
+
+---
+
+## Contributing
+
+Please feel free to fork our repo then submit a pull request: we'd love it if you would help us develop new features!
+
+You can also submit a 'feature request' issue: give us some example code if you feel like contributing personally!
+
+---
 
-First, clone our repo using `git clone https://github.com/Hacking3DPrinters/robotic-chess.git`, and enter the new directory. Then do `pip install dist/robotic_chess-0.2.1-py3-none-any.whl` (replace 0.2.1 with the desired version number), followed by `pip install -r requirements.txt`.
+## Status
 
-THIS DOES NOT INSTALL STOCKFISH OR OCTOPRINT (will be included in the future).
+This project is in ACTIVE DEVELOPMENT.
diff --git a/SECURITY.md b/SECURITY.md
@@ -4,10 +4,11 @@
 
 | Version | Supported          |
 | ------- | ------------------ |
-| >0.2.1  | ✅ Fully Supported (latest) |
-| 0.2.0   | ✳️ Fully Supported |
-| 0.1     | :x: Not Supported | 
-| 0.1a    | :x: Not Supported |
+| 1.0.0 | ✅ Fully Supported (latest) |
+| 1.0a/b/rc | ✳️ Partially Supported |
+| 0.2.x | :x: Not Supported |
+| 0.1 | :x: Not Supported | 
+| 0.1a | :x: Not Supported |
 
 ## Reporting a Vulnerability
 

diff --git a/config.ini b/config.ini
@@ -0,0 +1,15 @@
+[server]
+;Set OctoPrint server address and x-api-key
+ServerAddress = SERVER_ADDRESS_HERE
+ApiKey = API_KEY_HERE
+
+[preferences]
+;Set if the program uses colored or formatted text, this setting is turned off on windows due to cmd and powershell limitations
+FormattedText = true
+;Set if the program should check for updates
+UpdateCheck = true
+
+[printer]
+;Set maximum temperature that printer can be set to
+MaxExtruderTemp = 250
+MaxBedTemp = 85
diff --git a/dist/robotic_chess-1.0.0-py3-none-any.whl b/dist/robotic_chess-1.0.0-py3-none-any.whl
diff --git a/dist/robotic_chess-1.0.0.tar.gz b/dist/robotic_chess-1.0.0.tar.gz
diff --git a/dist/robotic_chess-1.0b0-py3-none-any.whl b/dist/robotic_chess-1.0b0-py3-none-any.whl
diff --git a/dist/robotic_chess-1.0b0.tar.gz b/dist/robotic_chess-1.0b0.tar.gz
diff --git a/dist/robotic_chess-1.0rc1-py3-none-any.whl b/dist/robotic_chess-1.0rc1-py3-none-any.whl
diff --git a/dist/robotic_chess-1.0rc1.tar.gz b/dist/robotic_chess-1.0rc1.tar.gz
diff --git a/example.gcode b/example.gcode
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "robotic_chess"
-version = "0.2.4"
+version = "1.1.0a1"
 authors = [
   { name="Benjamin Porter", email="[email protected]" },
 ]
@@ -16,7 +16,12 @@ classifiers = [
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
 ]
+dependencies = [
+    "stockfish@git+https://github.com/hacking3dprinters/stockfish-python.git",
+    "octoprint-cli==3.3.2",
+    "chess==1.10.0"
+]
 
 [project.urls]
-Homepage = "https://github.com/hippoprogrammer/robotic-chess"
-Issues = "https://github.com/hippoprogrammer/robotic-chess/issues"
+Homepage = "https://github.com/hacking3dprinters/robotic-chess"
+Issues = "https://github.com/hacking3dprinters/robotic-chess/issues"
diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,4 @@
 # pip requirements file for robotic-chess
-stockfish==3.28.0
+git+https://github.com/hacking3dprinters/stockfish-python.git#egg=stockfish
 octoprint-cli==3.3.2
 chess==1.10.0
diff --git a/setup.py b/setup.py
@@ -0,0 +1,21 @@
+from setuptools import setup
+from os import system
+import platform
+import getpass
+
+if __name__ == "__main__":
+  if platform.system()=='Linux':
+    setup()
+    system('git clone https://github.com/official-stockfish/Stockfish.git')
+    system('cd Stockfish/src/ && make -j build')
+    system('sudo mv Stockfish/src/stockfish /usr/local/bin/')
+    system('sudo chmod a+x /usr/local/bin/stockfish')
+    system('mv config.ini ~/.config/octoprint-cli.ini')
+  elif platform.system()=='Windows':
+    setup()
+    system('tar -xf stockfish-windows.zip')
+    system('mkdir C:/Users/'+getpass.getuser()+'/stockfish/')
+    system('move stockfish/stockfish-windows-x86-64-sse41-popcnt.exe C:/Users/'+getpass.getuser()+'/stockfish/stockfish.exe')
+    # config.ini does not need to be moved
+  else:
+    raise OSError('OS unsupported.')
diff --git a/src/robotic_chess.egg-info/PKG-INFO b/src/robotic_chess.egg-info/PKG-INFO
@@ -1,42 +1,83 @@
 Metadata-Version: 2.1
 Name: robotic_chess
-Version: 0.2.4
+Version: 1.0.0
 Summary: A 3D printer-based chess playing robot.
 Author-email: Benjamin Porter <[email protected]>
-Project-URL: Homepage, https://github.com/hippoprogrammer/robotic-chess
-Project-URL: Issues, https://github.com/hippoprogrammer/robotic-chess/issues
+Project-URL: Homepage, https://github.com/hacking3dprinters/robotic-chess
+Project-URL: Issues, https://github.com/hacking3dprinters/robotic-chess/issues
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: stockfish@ git+https://github.com/hacking3dprinters/stockfish-python.git
+Requires-Dist: octoprint-cli==3.3.2
+Requires-Dist: chess==1.10.0
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/Hacking3DPrinters/robotic-chess/main/3DCHESS.png", width=20%, height=auto />
+</p>
+
 
 # Robotic Chess
 
-An chess playing robot, powered by Stockfish.
+An chess playing robot, powered by Stockfish and Octoprint.
 For documentation, see [our wiki](https://github.com/Hacking3DPrinters/robotic-chess/wiki).
 
 ---
 
+## Requirements
+
+### Essentials
+* 3-core CPU and at least 3GB of RAM (theoretically this can run with only 2 cores and 2GB of RAM, but at the risk of crashing / hanging your computer)
+* A Linux-based operating system with sudo OR a Windows 10/11 operating system.
+* Python 3.10+ and pip
+* Octoprint server connected to a 3D printer
+* An electromagnet connected to M106/M107 extruder fan control
+
+### Recommended
+* 4-core+ CPU and at least 6GB of RAM
+* Python 3.11+ and pip
+* Knowledge of simple Linux commands
+
+---
+
 ## Installation
 
-### Installation from wheel
+### Installation from wheel (beta for Linux)
 
-First, visit [our releases page](https://github.com/Hacking3DPrinters/robotic-chess/releases) and download the `.whl` and `requirements.txt` files from the desired version.
+First, visit [our releases page](https://github.com/Hacking3DPrinters/robotic-chess/releases) and download the `.whl` file from the desired version (the 'latest' version is recommended).
 
 Then, run 
 ```pip install robotic_chess-0.2.1-py3.whl```
 (replace 0.2.1 with the version number of your downloaded wheel).
 
-Finally, run 
-```pip install -r requirements.txt```
-to install dependencies.
+You must then edit `~/.config/octoprint-cli.ini` and input the server details of your octoprint server.
+
+### Installation from source (recommended for Windows or Linux dev builds)
 
-THIS DOES NOT INSTALL STOCKFISH OR OCTOPRINT (will be included in the future).
+First, clone our repo using `git clone https://github.com/Hacking3DPrinters/robotic-chess.git`, and enter the new directory. 
+Then edit `config.ini` with your server details of the octoprint server.
 
-### Installation from source 
+Then run `python3 setup.py` to begin setup.
+
+---
+
+## Running
+
+Run `python3 -m robotic_chess`.
+
+---
+
+## Contributing
+
+Please feel free to fork our repo then submit a pull request: we'd love it if you would help us develop new features!
+
+You can also submit a 'feature request' issue: give us some example code if you feel like contributing personally!
+
+---
 
-First, clone our repo using `git clone https://github.com/Hacking3DPrinters/robotic-chess.git`, and enter the new directory. Then do `pip install dist/robotic_chess-0.2.1-py3-none-any.whl` (replace 0.2.1 with the desired version number), followed by `pip install -r requirements.txt`.
+## Status
 
-THIS DOES NOT INSTALL STOCKFISH OR OCTOPRINT (will be included in the future).
+This project is in ACTIVE DEVELOPMENT.
diff --git a/src/robotic_chess.egg-info/SOURCES.txt b/src/robotic_chess.egg-info/SOURCES.txt
@@ -1,11 +1,13 @@
 LICENSE
 README.md
 pyproject.toml
-src/robotic_chess/__init__.py
-src/robotic_chess/chess.py
+setup.py
+src/robotic_chess/__main__.py
+src/robotic_chess/engine.py
 src/robotic_chess/gcode.py
 src/robotic_chess/octoprint.py
 src/robotic_chess.egg-info/PKG-INFO
 src/robotic_chess.egg-info/SOURCES.txt
 src/robotic_chess.egg-info/dependency_links.txt
+src/robotic_chess.egg-info/requires.txt
 src/robotic_chess.egg-info/top_level.txt
diff --git a/src/robotic_chess.egg-info/requires.txt b/src/robotic_chess.egg-info/requires.txt
@@ -0,0 +1,3 @@
+stockfish@ git+https://github.com/hacking3dprinters/stockfish-python.git
+octoprint-cli==3.3.2
+chess==1.10.0
diff --git a/src/robotic_chess/__init__.py b/src/robotic_chess/__init__.py