AAGRINDER software - Revision history

Maze: /* Client */ mention websocket

2024-05-15T15:22:36Z

Client: mention websocket

Maze: clarify that dependencies are optnionsal

2022-10-18T15:49:06Z

clarify that dependencies are optnionsal

Maze: Update dependency list

2022-08-14T22:08:52Z

Update dependency list

Maze: /* Code */

2020-03-23T12:29:38Z

Code

imported>Maze: /* Language and environment */

2019-10-13T08:39:27Z

Language and environment

imported>Maze: /* Language and environment */

2019-10-13T08:34:17Z

Language and environment

imported>Maze: /* Version control */

2019-10-05T16:56:47Z

Version control

imported>Maze at 16:56, 5 October 2019

2019-10-05T16:56:17Z

imported>Maze: /* Production software */ wikipedia

2019-10-05T16:38:16Z

Production software: wikipedia

imported>Maze: Created page with "This page describes the dependencies of AAGRINDER, as well as software related to it in other ways. == Language and environment == The AAGRINDER client runs in a web browser..."

2019-10-05T16:24:54Z

Created page with "This page describes the dependencies of AAGRINDER, as well as software related to it in other ways. == Language and environment == The AAGRINDER client runs in a web browser..."

New page

This page describes the dependencies of AAGRINDER, as well as software related to it in other ways.

== Language and environment ==
The AAGRINDER client runs in a web browser and is written in the language [[wikipedia:Javascript|Javascript]]. To allow shared client-server code, the server is also written in Javascript. The server uses [[wikipedia:Node.js|Node.js]] to run Javascript. However, the [[AAGRINDER terrain generator]] is a separate application and is written in the language [[wikipedia:C%2B%2B|C++]].

The AAGRINDER server requires a MySQL or MySQL-compatible database for storing account data. This is not required if the server is running in [[Running in insecure mode|insecure mode]].

== Dependencies ==
=== Client ===
The only dependency of the AAGRINDER client is the library [https://socket.io/ socket.io], which is used for asynchronous communication between the client and the server.

=== Server ===
The AAGRINDER server, running in Node.js, has the following npm packages as dependecies:
* [https://www.npmjs.com/package/bcryptjs bcryptjs] (used for cryptography with account passwords)
* [https://www.npmjs.com/package/express express] (used for serving web pages)
* [https://www.npmjs.com/package/mysql mysql] (used for connecting to the MySQL database)
* [https://www.npmjs.com/package/socket.io socket.io] (used for asynchronous communication with the client)

=== Terrain generator ===
The [[AAGRINDER terrain generator]] includes the library [http://libnoise.sourceforge.net/ libnoise], which is used for generating [[wikipedia:Coherence_(signal_processing)|coherent noise]].

== Production software ==
Only text editors were used to write the code for AAGRINDER. As no game engines/frameworks are used, nothing binds it to any particular set of development software. Even though it has only one developer, many different text editors were used over the course of its development:
* [[wikipedia:Notepad%2B%2B|Notepad++]]
* [[Visual_Studio_Code|Visual Studio Code]]
* [[Atom_(text_editor)|Atom]]
* [[Vim_(text_editor)|Vim]]

@@ Line 16: / Line 16: @@
 * [https://www.npmjs.com/package/express express] (used for serving web pages)
 * [https://www.npmjs.com/package/socket.io socket.io] (used for asynchronous communication with the client)
-* [https://www.npmjs.com/package/js-yaml js-yaml] (used only for Matrix bridge)
+* [https://www.npmjs.com/package/js-yaml js-yaml] (optional; used only for Matrix bridge)
-* [https://www.npmjs.com/package/uuid uuid] (used only for Matrix bridge)
+* [https://www.npmjs.com/package/uuid uuid] (optional; used only for Matrix bridge)
-* [https://www.npmjs.com/package/matrix-bot-sdk matrix-bot-sdk] (used only for Matrix bridge)
+* [https://www.npmjs.com/package/matrix-bot-sdk matrix-bot-sdk] (optional; used only for Matrix bridge)
-* [https://www.npmjs.com/package/sharp sharp] (used only for Matrix bridge)
+* [https://www.npmjs.com/package/sharp sharp] (optional; used only for Matrix bridge)
 === Terrain generator ===

@@ Line 27: / Line 27: @@
 * [[wikipedia:Atom_(text_editor)|Atom]]
 * [[wikipedia:Vim_(text_editor)|Vim]]
 === Version control ===
 [[wikipedia:Git|Git]] is used for keeping track of changes in code. The repository used to be on [[wikipedia:GitHub|GitHub]], but [[History|was later moved]] to [[wikipedia:GitLab|GitLab]] and can be found at https://gitlab.com/MRAAGH/aagrinder.

← Older revision		Revision as of 16:56, 5 October 2019
Line 29:		Line 29:

	=== Version control ===		=== Version control ===
−	[[wikipedia:Git\|Git]] is used for keeping track of changes in code. The repository used to be on [[wikipedia:GitHub\|GitHub]], but [History\|was later moved] to [[wikipedia:GitLab\|GitLab]] and can be found at https://gitlab.com/MRAAGH/aagrinder.	+	[[wikipedia:Git\|Git]] is used for keeping track of changes in code. The repository used to be on [[wikipedia:GitHub\|GitHub]], but [[History\|was later moved]] to [[wikipedia:GitLab\|GitLab]] and can be found at https://gitlab.com/MRAAGH/aagrinder.

@@ Line 21: / Line 21: @@
 == Production software ==
 Only text editors were used to write the code for AAGRINDER. As no game engines/frameworks are used, nothing binds it to any particular set of development software. Even though it has only one developer, many different text editors were used over the course of its development:
 * [[wikipedia:Notepad%2B%2B|Notepad++]]
@@ Line 26: / Line 27: @@
 * [[wikipedia:Atom_(text_editor)|Atom]]
 * [[wikipedia:Vim_(text_editor)|Vim]]

@@ Line 10: / Line 10: @@
 === Client ===
 The only dependency of the AAGRINDER client is the library [https://socket.io/ socket.io], which is used for asynchronous communication between the client and the server.
 === Server ===

@@ Line 1: / Line 1: @@
 This page describes the dependencies of AAGRINDER, as well as software related to it in other ways.
@@ Line 4: / Line 5: @@
 The AAGRINDER client runs in a web browser and is written in the language [[wikipedia:Javascript|Javascript]]. To allow shared client-server code, the server is also written in Javascript. The server uses [[wikipedia:Node.js|Node.js]] to run Javascript. However, the [[AAGRINDER terrain generator]] is a separate application and is written in the language [[wikipedia:C%2B%2B|C++]].
-The AAGRINDER server requires a MySQL or MySQL-compatible database for storing account data. This is not required if the server is running in [[Running in insecure mode|insecure mode]].
+Older versions of AAGRINDER require a MySQL-compatible database for storing account data. As of 8th of July 2022, a database is not needed and a simple JSON file is used instead. Very old versions of AAGRINDER (2017) require a MongoDB database for storing account data.
 == Dependencies ==
@@ Line 14: / Line 15: @@
 * [https://www.npmjs.com/package/bcryptjs bcryptjs] (used for cryptography with account passwords)
 * [https://www.npmjs.com/package/express express] (used for serving web pages)
 * [https://www.npmjs.com/package/socket.io socket.io] (used for asynchronous communication with the client)
 === Terrain generator ===
-The [[AAGRINDER terrain generator]] includes the library [http://libnoise.sourceforge.net/ libnoise], which is used for generating [[wikipedia:Coherence_(signal_processing)|coherent noise]].
+The [[AAGRINDER terrain generator]] includes parts of the library [http://libnoise.sourceforge.net/ libnoise], which is used for generating [[wikipedia:Coherence_(signal_processing)|coherent noise]].
 == Production software ==

@@ Line 2: / Line 2: @@
 == Language and environment ==
-The AAGRINDER client runs in a web browser and is written in the language [[wikipedia:Javascript|Javascript]]. To allow shared client-server code, the server is also written in Javascript. The server uses [[wikipedia:Node.js|Node.js]] to run Javascript. However, the [[terrain generation|AAGRINDER terrain generator]] is a separate application and is written in the language [[wikipedia:C%2B%2B|C++]].
+The AAGRINDER client runs in a web browser and is written in the language [[wikipedia:Javascript|Javascript]]. To allow shared client-server code, the server is also written in Javascript. The server uses [[wikipedia:Node.js|Node.js]] to run Javascript. However, the [[AAGRINDER terrain generator]] is a separate application and is written in the language [[wikipedia:C%2B%2B|C++]].
 The AAGRINDER server requires a MySQL or MySQL-compatible database for storing account data. This is not required if the server is running in [[Running in insecure mode|insecure mode]].

@@ Line 23: / Line 23: @@
 Only text editors were used to write the code for AAGRINDER. As no game engines/frameworks are used, nothing binds it to any particular set of development software. Even though it has only one developer, many different text editors were used over the course of its development:
 * [[wikipedia:Notepad%2B%2B|Notepad++]]
-* [[Visual_Studio_Code|Visual Studio Code]]
+* [[wikipedia:Visual_Studio_Code|Visual Studio Code]]
-* [[Atom_(text_editor)|Atom]]
+* [[wikipedia:Atom_(text_editor)|Atom]]
-* [[Vim_(text_editor)|Vim]]
+* [[wikipedia:Vim_(text_editor)|Vim]]