Skip to content

Commit d37ec47

Browse files
bernkastel02bernkastel02
committed
initial commit
0 parents  commit d37ec47

File tree

13 files changed

+3526
-0
lines changed

13 files changed

+3526
-0
lines changed

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules
2+
.idea/
3+
.vs/

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 GD Programming
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# GDDocs
2+
Some documentation for Geometry Dash's servers, and the game itself.
3+
---
4+
5+
**GDDocs** is a project built to openly give advanced information and readable information for aspiring developers looking to interface with Geometry Dash. Primarily, we aim to create this as a website for people to learn more about the inner workings of geometry dash, along with it's data.
6+
7+
## Running/Building
8+
**You will require Node.js `>12` or above to debug and run this project.**
9+
10+
GDDocs is built off of the `docsify` engine, outputted to a generator file to be able to work well on server environments, rather than GitHub pages. This is primarily to allow for easy domain usage and development in a place where it can always update, and be hosted upon locally rather than over GitHub's servers.
11+
12+
As such, rather than having to install using the package.json; (which we would reccommend doing anyways using `npm install`,) the installation and such has been included in `generator.js`.
13+
14+
```
15+
node generator.js
16+
```
17+
18+
To debug it, you will need to properly clone or pull this repository.
19+
20+
## Contributing
21+
22+
Contributions are preferrably made to the documentation, rather than the simple `generator.js` file; unless need be. Contributions to all aspects of this project are preferred to be made over pull requests and issues. Ideas on what to contribute or read over can be read in the [opened issues](https://github.com/gd-programming/gddocs/issues) section of this repository.

‎docs/.nojekyll‎

Whitespace-only changes.

‎docs/README.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Introduction
2+
3+
Welcome to the Geometry Dash Programming [Discord](https://discord.gg/bV6NBs) server's online iteration of documentation for Geometry Dash. Here, you'll find all sorts of information, documents, and resources for interacting with [Geometry Dash](http://robtopgames.com). We aim to make [GDDocs](https://github.com/gd-programming/gddocs) the most comprehensive and open source of information for the game, created by many people who have interacted with the game and wish to share such with others.
4+
5+
The provided documentation is available on it's repository, over [here](https://github.com/gd-programming/gddocs). For all issues regarding information found here, please consult us by creating an issue.
6+
7+
## Projects
8+
9+
### Geometry Dash Wrappers
10+
11+
A few people, or teams have gone out of their way to create proper wrappers and API's around the **Geometry Dash** servers and it's client. All of the known and endorsed projects will find their way here, as a listing of resources people can use for their own projects.
12+
13+
#### Python
14+
* [gd.py](https://github.com/NeKitDS/gd.py) by [NeKitDS](https://github.com/NeKitDS)
15+
16+
#### C#
17+
* [GDAPI](https://github.com/gd-edit/GDAPI) by the [GDEdit Team](https://github.com/gd-edit)
18+
* [GDNET](https://github.com/GDdotNET/GDNET) by the [GD.NET Team](https://github.com/GDdotNET)
19+
20+
### Geometry Dash Projects
21+
22+
These are generally projects that generally interface over the Geometry Dash servers, and overall have built up their own recognition and traction along the community, and developers alike.
23+
24+
#### Node.js
25+
* [GDBrowser](https://github.com/GDColon/GDBrowser) by [GDColon](https://github.com/GDColon)
26+
27+
#### C#
28+
* [GDEdit](https://github.com/gd-edit/GDE) by the [GDEdit Team](https://github.com/gd-edit)
29+
30+
## Outside Remarks
31+
32+
With this documentation, the Geometry Dash Programming staff team would love to see your interesting ideas with this project, and the kinds of things you create with the information provided. Make sure to hit us up on our discord, and show us of such!

‎docs/_sidebar.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<!-- docs/_sidebar.md -->
2+
3+
* [Intro](/)
4+
* [Reference](/reference.md)

‎docs/index.html‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<title>Geometry Dash Documentation</title>
6+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
7+
<meta name="description" content="GD Documentation">
8+
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
9+
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/dark.css">
10+
</head>
11+
<body>
12+
<div id="app"></div>
13+
<script>
14+
window.$docsify = {
15+
name: 'GD Documentation',
16+
loadSidebar: true
17+
}
18+
</script>
19+
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
20+
</body>
21+
</html>

‎docs/reference.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# GD API References
2+
3+
The **Geometry Dash** servers are based around one main HTTP server, rather than primarily through secondary sources or establishing a direct REST api for usage. All endpoints are stored over the `/database` folder, rather than the base.
4+
5+
###### Server/Database URL
6+
```
7+
http://www.boomlings.com/database
8+
```

‎docs/resources/level.md‎

Whitespace-only changes.

‎generator.js‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
const child_process = require("child_process");
2+
const app = require("express")();
3+
const chalk = require("chalk");
4+
5+
// package installer
6+
require(`${__dirname}/scripts/install_packages.js`);
7+
8+
// serve data
9+
console.log(chalk.hex("#66d9ff")("Running Command: ") +`node ${__dirname}/node_modules/docsify-cli/bin/docsify serve ./docs --port 8080`)
10+
let docs_process = child_process.exec(`node ${__dirname}/node_modules/docsify-cli/bin/docsify serve ./docs --port 8080`);
11+
12+
docs_process.on("exit", () => {
13+
process.exit(0);
14+
})

0 commit comments

Comments
 (0)