bendns' repos / chess
online multiplayer chess game (note server currently down)
create instructions for how to use
Browse Source
bendn 2022-08-29
parent 5e0fa24 · commit 00e18b1
Diffstat
-rw-r--r--.gitignore9
-rw-r--r--CONTRIBUTING.md14
-rw-r--r--README.md7
-rwxr-xr-xinstall_addons.sh8
4 files changed, 27 insertions, 11 deletions
diff --git a/.gitignore b/.gitignore
index edfbdf0..588afcb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,10 +1,3 @@
.import/
-logs/
-*.sh
-*.py
-*.pgn
-.vscode/
-exports/
-*.x86_64
+addons/
version
-addons/gdcli
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..79689bf
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,14 @@
+# How to contribute
+
+## Prerequisites
+
+- Understanding of [pull requests](https://help.github.com/articles/using-pull-requests) and [issues](https://guides.github.com/features/issues/).
+- A basic understanding of godot, and `GDScript`.
+
+---
+
+## Installation
+
+- [Fork this repository](https://github.com/bend-n/chess/fork)
+- Clone your fork (`git clone https://github.com/<me>/chess`)
+- Run `install_addons.sh`
diff --git a/README.md b/README.md
index b4f7c34..304cf19 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,10 @@
# Chess
[![build](https://img.shields.io/github/workflow/status/bend-n/chess/export?logo=github&style=for-the-badge)](https://github.com/bend-n/chess/actions/workflows/export.yml "Build workflow")
-[![license](https://img.shields.io/badge/License-MIT-blue?style=for-the-badge)](https://github.com/bend-n/chess/blob/main/LICENSE "License")
[![issues](https://img.shields.io/github/issues/bend-n/chess?logo=github&style=for-the-badge)](https://github.com/bend-n/chess/issues "Issues")
-[![version](https://img.shields.io/badge/3.x-blue?logo=godot-engine&logoColor=white&label=godot&style=for-the-badge)](https://godotengine.org "Made with godot")
+[![contributing](https://img.shields.io/badge/contributions-open-brightgreen?style=for-the-badge)](https://github.com/bend-n/chess/blob/main/CONTRIBUTING.md)
+[![license](https://img.shields.io/badge/License-MIT-blue?style=for-the-badge)](https://github.com/bend-n/chess/blob/main/LICENSE "License")
+[![version](https://img.shields.io/badge/3.5-blue?logo=godot-engine&logoColor=white&label=godot&style=for-the-badge)](https://godotengine.org "Made with godot")
<a href='https://ko-fi.com/bendn' title='Buy me a coffee' target='_blank'><img height='28' src='https://storage.ko-fi.com/cdn/brandasset/kofi_button_red.png' alt='Buy me a coffee'> </a>
-[![screenshot](https://github.com/bend-n/chess/blob/main/.github/screenshot.png)](https://bendn.itch.io/chess "Playing.. Against myself")
+[![screenshot](https://raw.githubusercontent.com/bend-n/chess/main/.github/screenshot.png)](https://bendn.itch.io/chess "Playing.. Against myself")
diff --git a/install_addons.sh b/install_addons.sh
new file mode 100755
index 0000000..98a3ef2
--- /dev/null
+++ b/install_addons.sh
@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+rm -rf addons && mkdir addons
+git clone --depth 1 https://github.com/you-win/godot-package-manager
+mv godot-package-manager/addons/godot-package-manager addons/
+rm -rf godot-package-manager
+godot -s --no-window addons/godot-package-manager/cli.gd update
+rm -rf addons/godot-package-manager