Skip to content

Commit

Permalink
Legacy readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@izy521
izy521 committed Nov 17, 2015
1 parent 7992cae commit 4cc7a76
Showing 1 changed file with 367 additions and 0 deletions.
367 changes: 367 additions & 0 deletions docs/README-legacy.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,367 @@
# discord.io
A low-level library for creating a Discord client from Node.js. [Come join the discussion!](https://discord.gg/0MvHMfHcTKVVmIGP)

### Warning:
I'd recommend updating frequently during the start of the project. I've also been told, by one of the developers, "we change it [The API] often", so I'll try to keep the updates regular.

# What you'll need
* An email and password from Discord. The client doesn't support anonymous joining.

# How to install
````javascript
npm install discord.io
````

# Events
Events for the bot.

## ready
````javascript
bot.on('ready', function(rawEvent) { });
````
* **rawEvent** : The entire event received in JSON.


## message
````javascript
bot.on('message', function(user, userID, channelID, message, rawEvent) { });
````

* **user** : The user's name.
* **userID** : The user's ID.
* **channelID** : The ID of the room where the bot received the message.
* **message** : The chat message.
* **rawEvent** : The entire event received in JSON.

## presence
````javascript
bot.on('presence', function(user, userID, status, rawEvent) { });
````
* **user** : The user's name.
* **userID** : The user's ID.
* **status** : The user's status. Currently observed: ['online', 'idle', 'offline']
* **rawEvent** : The entire event received in JSON.

## debug
````javascript
bot.on('debug', function(rawEvent) { });
````
* **rawEvent** : In this section, it logs ANY event received from Discord.

## err
````javascript
bot.on('err', function(error) { });
````
* **error** : Logs the backend error (login, connection issues, etc).

## disconnected
````javascript
bot.on('disconnected', function() { });
````

# Properties

The client comes with a few properties to help your coding.
* **id** -String-
* **username** -String-
* **email** -String-
* **verified** -Bool-
* **discriminator** -String-
* **avatar** -String-
* **servers** -Object-
* **[Server Choice]** -Object-
* **channels** -Array-
* **members** -Array-
* **roles** -Array-
* **directMessages** -Object-
* **internals** -Object-
* **token** -String-

# Methods
Methods that get the bot to do things.

## -Connection-

### connect()
Connects to Discord.
````javascript
bot.connect()
````

### disconnect()
Disconnects from Discord and emits the "Disconnected" event.
````javascript
bot.disconnect()
````
## -Bot Status-

### editUserInfo(-Object-, [callback(response)])
````javascript
bot.editUserInfo({
avatar: 'ImageEncodedIntoBase64String', //Optional
email: '[email protected]', //Optional
new_password: 'supersecretpass123', //Optional
password: 'supersecretpass', //Required
username: 'Yuna' //Optional
});
````

### setUserPresence(-Object-)
````javascript
bot.setPresence({
idle_since: Date.now() //Optional, sets your presence to idle,
//can also be null for online
game_id: 405 //Optional, indicates you are playing a game
//can also be null to remove game
})
````

## -Bot Content Actions-

**The sendMessages() and sendFiles() helper functions (included in the example.js) accept a third and fourth argument. The third can be either a number interval or a callback function containing an array of responses for messages sent. The fourth is only the callback.**

### sendMessage(-Object-, [callback(response)])
````javascript
bot.sendMessage({
to: "userID/channelID",
message: "Hello World",
nonce: "80085" //Optional
} function(response) { //CB Optional
console.log(response.id); //Message ID
});

//Or, assuming the helper function is there, from the example

sendMessages(channelID, ["An", "Array", "Of", "Messages"]);
//Will send them each as their own message
````
A recent Discord update now forbids you from Direct Messaging a user that does not share a server with you.

### uploadFile(-Object-, [callback(response)])
````javascript
bot.uploadFile({
channel: "Your Channel ID",
file: "fillsquare.png"
}, function(response) { //CB Optional
console.log(response)
});

//Or, assuming the helper function is there, from the example

sendFiles(channelID, ["fillsquare.png", "anotherpossibleimage.png"]);
//Will send them each as their own message/file
````
### getMessages(-Object-, callback(messageArray))
````javascript
bot.getMessages({
channel: "Your Channel ID",
before: "messageID", //Optional
after: "messageID" //Optional
limit: 50 //If 'limit' isn't added, it defaults to 50, the Discord default
}, function(messageArr) {
//Do something with your array of messages
});
````

### editMessage(-Object-, [callback(response)])
````javascript
bot.editMessage({
channel: "Your Channel ID",
messageID: rawEvent.d.id,
message: "Your new message"
}, function(response) { //CB Optional
console.log(response);
});
````

### deleteMessage(-Object-)
````javascript
bot.deleteMessage({
channel: "Your Channel ID",
messageID: rawEvent.d.id
});
````

### fixMessage(-String-)
````javascript
//Assuming someone typed "Hello @izy521"
bot.on('message', function(user, userID, channelID, message, rawEvent) {
console.log(message) //"Hello <@66186356581208064>"
console.log(bot.fixMessage(message)) //"Hello @izy521"
});
````

## -Bot Management Actions-

### createServer(-Object-, [callback(response)])
````javascript
bot.createServer({
icon: null,
name: "Test server",
region: "london" //If you can't remember your preferred server, the bot will give you a list from Discord
});
````

### deleteServer(-Object-, [callback(response)])
````javascript
bot.deleteServer({
server: "Your Server ID"
});
````

### createChannel(-Object-, [callback(response)])
````javascript
bot.createChannel({
server: "Your Server ID",
type: "text", //or "voice"
name: "CoolNameBruh"
});
````

### deleteChannel(-Object-, [callback(response)])
````javascript
bot.deleteChannel({
channel: "Your Channel ID"
});
````

### editChannelInfo(-Object-, [callback(response)])
````javascript
bot.editChannelInfo({
name: "New Channel", //Optional
position: 0, //Optional
topic: "Our new topic" //Optional
});
````

### acceptInvite(-String-, [callback(response)])
````javascript
bot.acceptInvite("0MvHMfHcTKVVmIGP")
````

### createInvite(-String-, [callback(response)])
````javascript
bot.createInvite({
channel: "Your Channel ID / Server ID"
}, function(res) {
console.log(res.code); //The invite code, just paste it together with the discord.gg url
})
````

### createRole(-String-)
```javascript
bot.createRole("Your Server ID");
//There's no response, unfortunately. You'll have to listen to the websocket's debug for the role ID.
```

### editRole(-Object-)
Please read the [Permissions](https://github.com/izy521/discord.io/blob/master/docs/permissions.md) and [Colors](https://github.com/izy521/discord.io/blob/master/docs/colors.md) readmes, only so you don't destroy your roles and unleash chaos upon your server. (Won't actually go through if there are any issues)
```javascript
bot.editRole({
server: "Your Server ID",
role: "Your Role ID",
name: "Awesome Role Name",
hoist: true, //or false, will seperate them
permissions: {
GENERAL_CREATE_INSTANT_INVITE: false,
TEXT_MENTION_EVERYONE: true,
VOICE_CONNECT: true
}, //Read the permissions readme, IMPORTANT
color: "DARK_AQUA" //Read the colors readme, IMPORTANT
});
```

### deleteRole(-Object-)
```javascript
bot.deleteRole({
server: "Your Server ID",
role: "Your Role ID"
});
```

### addToRole(-Object-)
````javascript
bot.addToRole({
server: "Your Server ID",
user: "The User ID",
role: "The Role ID"
});
````

### removeFromRole(-Object-)
````javascript
bot.removeFromRole({
server: "Your Server ID",
user: "The User ID",
role: "The Role ID"
});
````

##### The following are similar in syntax.

* ### kick(-Object-)
* ### ban(-Object-)
* ### unban(-Object-)
* ### mute(-Object-)
* ### unmute(-Object-)
* ### deafen(-Object-)
* ### undeafen(-Object-)

````javascript
bot.kick({
channel: "Server or Channel ID",
target: "User ID",
lastDays: 1 //ONLY used in banning. A number that can be either 1 or 7. It's also optional.
});

//The rest are the same
````

## -Voice-
Just laying down the foundation, sending audio has yet to be finalized.
### joinVoiceChannel(-String-, [callback()])
```javascript
bot.joinVoiceChannel("66192955798458368", function() {
bot.testAudio(etc);
});
```

### leaveVoiceChannel(-String-)
```javascript
bot.leaveVoiceChannel("66192955798458368")
```

### testAudio(-Object-)
As the name specifies, it's a test. Still being developed and not finished.

**WARNING**: If you want the input file to be audible at all, it MUST be a: .WAV, 48kHz, mono (can be stereo, but Discord transforms it back into mono) file.
```javascript
bot.testAudio({
server: "Your Server ID",
channel: "Your VOICE Channel ID",
stream: require('fs').createReadStream('music.wav')
});
```

## -Misc-

### serverFromChannel(-String-)
````javascript
bot.serverFromChannel("76213969290797056") //Returns "66192955777486848"
````

## Special Thanks
* **[Chris92](https://github.com/Chris92de)**
* Found out Discord's direct messaging method.
* **[Voltana](https://github.com/RogueException)**
* Figured out how to do the bitwise freaking... whatever, permissions.
* **[#q](https://github.com/qeled)**
* Essentially spelled out the whole voice process.

## Related projects
* [Discord.NET](https://github.com/RogueException/Discord.Net)
* [DiscordSharp](https://github.com/Luigifan/DiscordSharp)
* [discord.js](https://github.com/discord-js/discord.js)
* [Discord4J](https://github.com/knobody/Discord4J)
* [PyDiscord](https://github.com/Rapptz/pydiscord)

0 comments on commit 4cc7a76

Please sign in to comment.