Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix inconsistency and misinformation in gddocs #63

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/endpoints/accounts/loginGJAccount.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@

| Parameter | Explanation | Optional |
| :--------- | :---------------------------------------------------------------------------------------------------- | :------- |
| `udid` | [The user's Universal Unique Identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier) | `False` |
| `username` | The username for the account the player is trying to log into | `False` |
| `password` | The plaintext password for the account the player is trying to log into | `False` |
| `udid` | [Universal Unique Identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier) (Not important, just put whatever you want) | `False` |
| `userName` | The username for the account the player is trying to log into | `False` |
| `gjp2` | The [GJP2](/topics/gjp.md) of the account | `False` |
| `sID` | The player's steam ID | `True` |
| `secret` | Account Secret: `Wmfv3899gc9` | `False` |

**Note**
the `sID` parameter is only sent to the servers if the player is logging into their account from the steam release of Geometry Dash. From what has been observed, it has not been utilised.
The `sID` parameter is only sent to the servers if the player is logging into their account from the steam release of Geometry Dash. From what has been observed, it has not been utilised.

## Responses

Expand Down
2 changes: 1 addition & 1 deletion docs/endpoints/accounts/register.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# accounts/register.php

Account registration via a webpage
> Account registration via a webpage
10 changes: 8 additions & 2 deletions docs/endpoints/levels/deleteGJLevelUser20.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Deletes a level from the server.

**accountID** - The level author's account ID

**gjp** - The level author's [GJP](/topics/encryption/gjp.md)
**gjp** - The level author's [GJP](/topics/gjp.md)

**levelID** - The ID of the level being deleted

Expand Down Expand Up @@ -48,8 +48,14 @@ req = requests.post("http://boomlings.com/database/deleteGJLevelUser20.php", dat
print(req.text)
```

### **curl**

```bash
curl http://boomlings.com/database/deleteGJLevelUser20.php -A "" -d "accountID=173831&gjp=********&levelID=62689548&secret=Wmfd2893gb7"
```

**Response**
```py
```plain
1
```

Expand Down
2 changes: 1 addition & 1 deletion docs/endpoints/levels/downloadGJLevel22.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ print(req.text)

### **curl**

```plain
```bash
curl http://www.boomlings.com/database/downloadGJLevel22.php -A "" -d "levelID=128&secret=Wmfd2893gb7"
```

Expand Down
8 changes: 7 additions & 1 deletion docs/endpoints/levels/getGJDailyLevel.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,14 @@ req = requests.post("http://boomlings.com/database/getGJDailyLevel.php", data=da
print(req.text)
```

### **curl**

```bash
curl http://boomlings.com/database/getGJDailyLevel.php -A "" -d "weekly=1&secret=Wmfd2893gb7"
```

**Response**
```py
```plain
100146|121576
```

Expand Down
8 changes: 7 additions & 1 deletion docs/endpoints/levels/getGJGauntlets21.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,14 @@ req = requests.post("http://boomlings.com/database/getGJGauntlets21.php", data=d
print(req.text)
```

### **curl**

```bash
curl http://boomlings.com/database/getGJGauntlets21.php -A "" -d "secret=Wmfd2893gb7"
```

**Response**
```py
```plain
1:1:3:27732941,28200611,27483789,28225110,27448202|1:2:3:20635816,28151870,25969464,24302376,27399722|1:3:3:28179535,29094196,29071134,26317634,12107595|1:4:3:26949498,26095850,27973097,27694897,26070995|1:5:3:18533341,28794068,28127292,4243988,28677296|1:6:3:28255647,27929950,16437345,28270854,29394058|1:7:3:25886024,4259126,26897899,7485599,19862531|1:8:3:18025697,23189196,27786218,27728679,25706351#74aeff3cb009cbde1d7235e1c7e74b47d793eb82
```

Expand Down
12 changes: 9 additions & 3 deletions docs/endpoints/levels/getGJLevelScores211.md

Large diffs are not rendered by default.

20 changes: 14 additions & 6 deletions docs/endpoints/levels/getGJLevelScoresPlat.md

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/endpoints/levels/getGJLevels21.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# getGJLevels21

> This endpoint is used to search levels by name and or filter
> This endpoint is used to search levels by name and or filter.

## Parameters

Expand All @@ -13,8 +13,8 @@
| `str` | Search query, user ID or level list depending on `type` | Only on types 5 and 10 |
| `page` | Which page to request, defaults to 0 | |
| `total` | Currently unknown. Defaults to the amount of levels available up to 9999, but 0 or leaving it out also work. | |
| `gjp` | The [GJP](/topics/encryption/gjp.md) for the `accountID`. Not present in 2.2 | |
| `gjp2` | The [GJP2](/topics/encryption/gjp.md) for the `accountID`. 2.2+ | |
| `gjp` | The [GJP](/topics/gjp.md) for the `accountID`. Not present in 2.2 | |
| `gjp2` | The [GJP2](/topics/gjp.md) for the `accountID`. 2.2+ | |
| `accountID` | The ID for the account which is doing the search. Only sent on types 8, 13 and 5 | |
| `gdw` | Whether the request is for GD World, either 0 or 1 | |
| `gauntlet` | The ID for the gauntlet being requested | |
Expand Down Expand Up @@ -160,7 +160,7 @@ print(req.text)

### **curl**

```plain
```bash
curl http://www.boomlings.com/database/getGJLevels21.php -A "" -d "str=bloodbath&star=1&type=0&secret=Wmfd2893gb7"
```

Expand Down
16 changes: 11 additions & 5 deletions docs/endpoints/levels/getGJMapPacks21.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ Gets the map packs.

**gdw** - 0

**page** - Denotes which page of map packs you want to retrieve, starting with 0
**page** - Denotes which page of map packs you want to retrieve, starting with 0.

## Response

The response is formatted as follows:

`packs#page#hash`

where:
Clarifications:

- Packs is a list of [map pack](/resources/server/mappack.md) objects, separated by a pipe `|
- Page is the page data in this format: `{total packs}:{current offset}:{page size}`
- [Hash](/resources/server/hashes.md?id=getgjmappacks) used to validate the request by the GD client
- `packs` is a list of [map pack](/resources/server/mappack.md) objects, separated by a pipe `|`.
- `page` is the page data in this format: `{total packs}:{current offset}:{page size}`.
- [`hash`](/resources/server/hashes.md?id=getgjmappacks) used to validate the request by the GD client.

## Example

Expand All @@ -50,6 +50,12 @@ req = requests.post("http://boomlings.com/database/getGJMapPacks21.php", data=da
print(req.text)
```

### **curl**

```bash
curl http://boomlings.com/database/getGJMapPacks21.php -A "" -d "page=4&secret=Wmfd2893gb7"
```

**Response**
```py
1:59:2:Cyclone Pack:3:1566116,946020,1100161:4:8:5:1:6:5:7:255,75,255:8:255,75,255|1:60:2:Colossus Pack:3:1350389,1215630,1724579:4:8:5:1:6:5:7:100,255,175:8:100,255,175|1:61:2:Diamond Pack:3:1267316,1670283,1205277:4:8:5:1:6:5:7:255,255,255:8:255,255,255|1:11:2:Chaos Pack:3:329929,188909,340602:4:9:5:1:6:5:7:255,125,0:8:255,125,0|1:44:2:Magma Pack:3:882417,884256,551979:4:9:5:1:6:5:7:255,100,50:8:255,100,50|1:62:2:Paradox Pack:3:1447246,1132530,1683722:4:9:5:1:6:5:7:50,255,75:8:50,255,75|1:63:2:Funky Pack:3:1728550,1799065,1311773:4:9:5:1:6:5:7:50,175,255:8:50,175,255|1:19:2:Remix Pack 4:3:341613,358750,369294:4:10:5:2:6:6:7:255,255,0:8:255,255,0|1:20:2:Demon Pack 1:3:70059,10109,135561:4:10:5:2:6:6:7:255,0,125:8:255,0,125|1:21:2:Demon Pack 2:3:57730,308891,102765:4:10:5:2:6:6:7:255,0,0:8:255,0,0#65:40:10#79c437d2cf75d2edf36a5094e0cc650c54440ba3
Expand Down
20 changes: 8 additions & 12 deletions docs/endpoints/levels/rateGJDemon21.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# rateGJDemon21.php

Rates the demon difficulty of a demon level - only works for Geometry Dash moderators
Rates the demon difficulty of a demon level - only works for Geometry Dash moderators.

## Parameters

Expand All @@ -14,31 +14,27 @@ Rates the demon difficulty of a demon level - only works for Geometry Dash moder

**accountID** - The accountID of the user who's rating the demon's difficulty

**gjp** - The [GJP](/topics/encryption/gjp.md) of the user who's rating the demon's difficulty
**gjp** - The [GJP](/topics/gjp.md) of the user who's rating the demon's difficulty

**levelID** - The ID of the demon being rated

**rating** - 1 for Easy Demon, 2 for Medium Demon, 3 for Hard Demon, 4 for Insane Demon and 5 for Extreme Demon
**rating** - 1 for Easy Demon, 2 for Medium Demon, 3 for Hard Demon, 4 for Insane Demon and 5 for Extreme Demon.

### Optional Parameters

**gdw** - 0

## Response

For normal Players: Internal Server Error or -1
For Normal Players: Internal Server Error or returns `-1`.

if mode=1

mod: levelID

normal user: -2
For Moderators: Returns level ID.

## Example

<!-- tabs:start -->

### **Python - normal Players**
### **Python - Normal Players**

```py
import requests
Expand All @@ -57,7 +53,7 @@ print(req.text)
```

**Response**
```py
```plain
-1
```

Expand All @@ -84,7 +80,7 @@ print(req.text)
```

**Response**
```py
```plain
4284013
```

Expand Down
12 changes: 6 additions & 6 deletions docs/endpoints/levels/rateGJStars211.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ Sends a star suggestion for a level

**secret** - Wmfd2893gb7

**levelID** - The ID of the level receiving the star suggestion
**levelID** - The ID of the level receiving the star suggestion.

**stars** - The amount of stars being suggested
**stars** - The amount of stars being suggested.

**rs** - 10 randomly generated characters from `[A-Za-z0-9]`
**rs** - [Random seed](/topics/encryption/id.md) generated.

**accountID** - Your account ID

**gjp2** - Your password, encrypted with [GJP2](/topics/gjp.md)

**udid** - Your UDID
**udid** - Your [UDID](/topics/encryption/id.md).

**uuid** - Your player ID (different from account ID)

Expand All @@ -34,7 +34,7 @@ Sends a star suggestion for a level

## Response

Always 1 if the parameters `secret`, `levelID` and `stars` are specified. `chk`, `udid`, `uuid`, `rs`, `accountID` and `gjp2` are technically not required but the star rating will not go through if these parameters aren't specified
Always `1` if the parameters `secret`, `levelID` and `stars` are specified. `chk`, `udid`, `uuid`, `rs`, `accountID` and `gjp2` are technically not required but the star rating will not go through if these parameters aren't specified.

## Example

Expand All @@ -56,7 +56,7 @@ print(req.text)
```

**Response**
```py
```plain
1
```

Expand Down
8 changes: 4 additions & 4 deletions docs/endpoints/levels/reportGJLevel.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# reportGJLevel.php

Reports a level
> Reports a level.

## Parameters

Expand All @@ -10,11 +10,11 @@ Reports a level

### Optional Parameters

**levelID** - The ID of the level being reported
**levelID** - The ID of the level being reported.

## Response

1 if a secret is passed, even if no levelID is passed, and -1 otherwise
`1` if a secret is passed, even if no levelID is passed, and `-1` otherwise.

## Example

Expand All @@ -35,7 +35,7 @@ print(req.text)
```

**Response**
```py
```plain
1
```

Expand Down
15 changes: 8 additions & 7 deletions docs/endpoints/levels/suggestGJStars.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,33 @@
# suggestGJStars20.php

Endpoint used by moderators to send levels to RobTop
> Endpoint used by moderators to send levels to RobTop.

## Parameters

### Required Parameters

**accountID** - accountID of the user
**accountID** - accountID of the user.

**gjp** - The [GJP](/topics/encryption/gjp.md) of the user
**gjp** - The [GJP](/topics/gjp.md) of the user.

**levelID** - the ID of the level

**stars** - how many stars that are requested
**stars** - How many stars that are requested.

**secret** - Wmfp3879gc3

**gameVersion** - the game version

**binaryVersion** - the binary version

**feature** - 0 for star rate, 1 for feature, 2 for epic, 3 for legendary, 4 for mythic
**feature** - 0 for star rate, 1 for feature, 2 for epic, 3 for legendary, 4 for mythic.

**gdw** - 0

## Response

-2 or 1
`-2` if not a moderator.
`1` if is a moderator.

## example

Expand Down Expand Up @@ -54,6 +55,6 @@ print(req.text)
```

**Response**
```py
```plain
1
```
10 changes: 5 additions & 5 deletions docs/endpoints/levels/updateGJDesc20.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ Updates the description of a level

### Required Parameters

**accountID** - The account ID of the level's author
**accountID** - The account ID of the level's author.

**gjp2** - The [GJP2](/topics/encryption/gjp.md) of the level's author
**gjp2** - The [GJP2](/topics/gjp.md) of the level's author.

**levelID** - The ID of the level

**levelDesc** - The new description of the level, converted to [URL-safe base64](/topics/encryption/base64)
**levelDesc** - The new description of the level, converted to [URL-safe base64](/topics/encryption/base64.md)

**secret** - Wmfd2893gb7

Expand All @@ -26,7 +26,7 @@ Updates the description of a level

## Response

1 if successful, -1 if not
`1` if successful, `-1` if not.

## Example

Expand All @@ -50,7 +50,7 @@ print(req.text)
```

**Response**
```py
```plain
1
```

Expand Down
8 changes: 4 additions & 4 deletions docs/endpoints/levels/uploadGJLevel21.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Uploads a created level to the servers.

### Required Parameters

**gameVersion** - The game version. Currently 22
**gameVersion** - The game version. Currently `22` (2.2).

**accountID** - The uploader's account ID
**accountID** - The uploader's account ID.

**gjp2** - The uploader's [GJP2](./topics/encryption/gjp.md)
**gjp2** - The uploader's [GJP2](./topics/gjp.md)

**userName** - The uploader's username

Expand Down Expand Up @@ -70,7 +70,7 @@ Uploads a created level to the servers.

## Response

Returns the ID of the uploaded level, or `-1` if the request was rejected.
Returns the ID of the uploaded level if successful, or `-1` if the request was rejected.

## Example

Expand Down
Loading