[435] RuneJS - An open-source RuneScape game server written in TypeScript & ES6

Quote:

---

Originally Posted by Dust R I P [Only registered and activated users can see links. Click Here To Register...]

Is there a specific reason you picked revision 435?

---

It's my personal favorite, right around the time I started playing. And it's the update they made on October 31st, 2006, Halloween - my favorite holiday. :)

Aside from that, it's also pretty close in time to 377, but has the much nicer new interface/widget system, skillcapes, and Construction. It's a good candidate for having all that, and being able to get away with using 377 maps with minimal manual edits.

Quote:

---

Originally Posted by TheBlackParade [Only registered and activated users can see links. Click Here To Register...]

It's my personal favorite, right around the time I started playing. And it's the update they made on October 31st, 2006, Halloween - my favorite holiday. :)

Aside from that, it's also pretty close in time to 377, but has the much nicer new interface/widget system, skillcapes, and Construction. It's a good candidate for having all that, and being able to get away with using 377 maps with minimal manual edits.

---

It's the side icons that's just breaking the 2006 vibe for me tbh it feels more early 07 then it feels 06, you can have all the luxury you mentioned with 421 and still have the old side icons/interfaces :)

Nice work, I’ll be watching this.

Posting an update today with some pictures of a little bit of content made using the plugin system by a few of the project's different contributors:

[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]

Gl man, looks sick will be following :D

Looks good my dude! It's very wild that you're writing this all in TypeScript. Hope you keep up the good work!

Quote:

---

Originally Posted by Hektic [Only registered and activated users can see links. Click Here To Register...]

Gl man, looks sick will be following :D

---

Quote:

---

Originally Posted by Alias [Only registered and activated users can see links. Click Here To Register...]

Looks good my dude! It's very wild that you're writing this all in TypeScript. Hope you keep up the good work!

---

Thanks! Feel free to join the Discord if you'd like more info or want to contribute anything. Doesn't have to be code, ideas and tips are always welcome. :)

Anyways, no posts for a bit... But I've been working on some cleanup and outside tools lately. Today I started on a quest handling system that integrates with the existing plugin system... It's very early and subject to change and ideas or suggestions. Currently quests are defined like so:

Code:

---

    cooksAssistant: {
        id: 0,
        questTabId: 27,
        name: `Cook's Assistant`,
        stages: {
            NOT_STARTED: `I can start this quest by speaking to the <col=800000>Cook</col> in the<br>` +
                `<col=800000>Kitchen</col> on the ground floor of <col=800000>Lumbridge Castle</col>.`,
            COLLECTING: (attr) => `collecting stuff`,
            COMPLETE: `completed`
        }
    }

---

The stages correspond to quest journal entires. Whatever the text is for that stage, is what will show up in the quest journal when the quest is clicked on in the player's quest tab. A quest stage can be set via player.setQuestStage(quest, stage), which will automatically update the quest tab entry to the correct color - red for NOT_STARTED, green for COMPLETE, and yellow for anything else. It can be integrated with the plugin system like so:

Code:

---

const startQuestAction: npcAction = (details) => {
    const { player, npc } = details;

    dialogueAction(player)
        .then(d => d.npc(npc, DialogueEmote.DISTRESSED_1, [ 'What am I to do?' ]))
        .then(d => d.options('Select an Option', [ `What's wrong?`, `Can you make me a cake?`, `You don't look very happy.`, `Nice hat!` ]))
        .then(d => {
        ... etc etc ...
};

const talkToCookDuringQuestAction: npcAction = (details) => {
    const { player, npc } = details;

    dialogueAction(player)
        .then(d => d.npc(npc, DialogueEmote.DEFAULT, [ `Hey fam, how's the ingredient hunt going?` ]))
        .then(d => d.close());
};

export default new RunePlugin([{
    type: ActionType.NPC_ACTION,
    quest: { questId: quests.cooksAssistant.id, stage: 'NOT_STARTED' },
    npcIds: npcIds.lumbridgeCook,
    options: 'talk-to',
    walkTo: true,
    action: startQuestAction
}, {
    type: ActionType.NPC_ACTION,
    quest: { questId: quests.cooksAssistant.id, stage: 'COLLECTING' },
    npcIds: npcIds.lumbridgeCook,
    options: 'talk-to',
    walkTo: true,
    action: talkToCookDuringQuestAction
}]);

---

The only difference to a regular plugin action is here is addition of quest: { questId: quests.cooksAssistant.id, stage: 'NOT_STARTED' }, which will tell the system that this is a quest action. When the plugins are run, the system will search for quest actions first and run those if the player is at the applicable quest stage for it... If there is a quest action that gets run, all actions following that get cancelled. The plugins are automatically sorted with quest plugins first so that quest actions will always be checked for before regular actions.

All that together gives us this:

[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]

Quests

Been working quite a bit on the quest system and a new dialogue system to go alongside it. Today I deemed it good enough to merge up to master so that others can play around with and test the two systems. While creating the system I was also implementing the Cook's Assistant quest, so here's some screenshots of how that is going so far (about 98% completed):

Spoiler for Cook's Assistant:

[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]
[Only registered and activated users can see links. Click Here To Register...]

The quest definition for this is fairly straightforward:

Code:

---

const quest: Quest = {
    id: 'cooksAssistant',
    questTabId: 27,
    name: `Cook's Assistant`,
    points: 1,
    stages: {
        NOT_STARTED: `I can start this quest by speaking to the <col=800000>Cook</col> in the ` +
            `<col=800000>Kitchen</col> on the ground floor of <col=800000>Lumbridge Castle</col>.`,
        COLLECTING: (player: Player) => {
            let questLog = `It's the <col=800000>Duke of Lumbridge's</col> birthday and I have to help ` +
                `his <col=800000>Cook</col> make him a <col=800000>birthday cake.</col> To do this I need to ` +
                `bring him the following ingredients:\n`;
            const quest = player.getQuest('cooksAssistant');

            if(player.hasItemInInventory(itemIds.bucketOfMilk) || quest.attributes.givenMilk) {
                questLog += `I have found a <col=800000>bucket of milk</col> to give to the cook.\n`;
            } else {
                questLog += `I need to find a <col=800000>bucket of milk.</col> There's a cattle field east ` +
                    `of Lumbridge, I should make sure I take an empty bucket with me.\n`;
            }

            if(player.hasItemInInventory(itemIds.potOfFlour) || quest.attributes.givenFlour) {
                questLog += `I have found a <col=800000>pot of flour</col> to give to the cook.\n`;
            } else {
                questLog += `I need to find a <col=800000>pot of flour.</col> There's a mill found north-` +
                    `west of Lumbridge, I should take an empty pot with me.\n`;
            }

            if(player.hasItemInInventory(itemIds.egg) || quest.attributes.givenEgg) {
                questLog += `I have found an <col=800000>egg</col> to give to the cook.\n`;
            } else {
                questLog += `I need to find an <col=800000>egg.</col> The cook normally gets his eggs from ` +
                    `the Groats' farm, found just to the west of the cattle field.`;
            }

            return questLog;
        },
        COMPLETE: { color: 0, text: `It was the Duke of Lumbridge's birthday, but his cook had ` +
                `forgotten to buy the ingredients he needed to make him a ` +
                `cake. I brought the cook an egg, some flour and some milk ` +
                `and the cook made a delicious looking cake with them.\n\n` +
                `As a reward he now lets me use his high quality range ` +
                `which lets me burn things less whenever I wish to cook ` +
                `there.\n\n` +
                `<col=ff0000>QUEST COMPLETE!</col>` }
    },
    completion: {
        rewards: [ '300 Cooking XP' ],
        onComplete: (player: Player): void => {
            player.skills.addExp(Skill.COOKING, 300);
        },
        itemId: 1891,
        modelZoom: 240,
        modelRotationX: 180,
        modelRotationY: 180
    }
};

---

Each stage listed within "stages" corresponds to a unique quest stage or state. The text or function provided there will be what shows up in the player's quest journal for that specific quest stage. Providing a string simply displays that string, while providing a function with the player as the single argument will run the given function and display the string returned by this function - so that minor checks can be run if the text within that entry is dynamic (in this case, it changes if the player has any of the 3 required ingredients).

The "completion" entry is for what will be shown on the Quest Complete screen. It will automatically show the quest points gained from completion of the quest, as well as showing anything else provided in the "rewards" array. Actual rewards can be given to the player via the "onComplete" function, where we give the player their 300 Cooking experience. The remainder of the options are for what item or model to show on the left side of the scroll and what zoom/rotation it should have.

Quests can also be declared in plugins, and the server will collect them all upon startup:

Code:

---

export default new RunePlugin({
    type: ActionType.QUEST,
    quest
});

---

This lets the server know about the quest definition. Quests can be progressed using the "player.setQuestStage" function, which will increase the quest stage and automatically run the Quest Complete process if the quest stage is set to "COMPLETE".

New Dialogue System

The dialogue chat system has been completely rebuilt to make it considerably easier to use and far more versatile. You can skip around to different sections of dialogue, run code within dialogues, run the player through different option trees, and more. The Cook's Assistant quest example makes full use of all the new dialogue system features.

Creating new dialogues now goes as such:

Code:

---

    dialogue([ player, { npc, key: 'gillie' }], [
        gillie => [ Emote.HAPPY, `Hello, I'm Gillie the Milkmaid. What can I do for you?` ],
        options => [
            `Who are you?`, [
                player => [ Emote.WONDERING, `Who are you?` ],
                gillie => [ Emote.GENERIC, `My name is Gillie Groats. My father is a farmer and I milk the cows for him.` ],
                player => [ Emote.WONDERING, `Do you have nay buckets of milk spare?` ],
                gillie => [ Emote.GENERIC, `I'm afraid not. We need all of our milk to sell to market, ` +
                    `but you can milk the cow yourself if you need the milk.` ],
                player => [ Emote.GENERIC, `Thanks.` ]
            ],
            `So how do you milk a cow then?`, [
                player => [ Emote.WONDERING, `So how do you milk a cow then?` ],
                gillie => [ Emote.HAPPY, `It's very easy. First you need an empty bucket to hold the milk.` ],
                gillie => [ Emote.HAPPY, `Then find a dairy cow to milk - you can't milk just any cow.` ],
                player => [ Emote.SKEPTICAL, `How do I find a dairy cow?` ],
                gillie => [ Emote.GENERIC, `They are easy to spot - they are dark brown and white, unlike ` +
                    `beef cows, which are light brown and white. We also tether them to a post to stop them ` +
                    `wandering around all over the place.` ],
                gillie => [ Emote.GENERIC, `There are a couple very near, in this field.` ],
                gillie => [ Emote.GENERIC, `Then just milk the cow and your bucket will fill with tasty, untritious milk.` ],
            ],
            `I'm fine, thanks.`, [
                player => [ Emote.GENERIC, `I'm fine, thanks.` ],
            ]
        ]
    ]);

---

The first part is the new "dialogue" function. This function accepts two parameters - a list of participants in the dialogue, and the tree of actual dialogue. The list of participants must contain a single player, even if the player never speaks, and may contain 0 to many NPC participants. An NPC participant contains an NPC instance or NPC id and a dialogue key for that NPC - in the case above we named the NPC "gillie" for use later in the dialogue tree.

A dialogue tree is just a list of dialogue actions to be performed in sequence. The first dialogue we see is "gillie => [ Emote.HAPPY, `Hello, I'm Gillie the Milkmaid. What can I do for you?` ]," - This basically says that the NPC "gillie" (the key given in the NPC participants array) will say "Hello, I'm Gillie the Milkmaid. What can I do for you?" with a HAPPY expression. Dialogues will automatically split into new lines if they are too long, or they can be manually split with the new line character (\n).

Next we have a list of options presented to the player, those options being "Who are you?", "So how do you milk a cow then?", and "I'm fine, thanks.". Selecting "I'm fine, thanks." simply makes the player say that and ends the dialogue. Selecing "Who are you?" runs through a subtree where Gillie informs the player about who she is. Finally, choosing "So how do you milk a cow then?" will make Gillie inform the player on how to milk a dairy cow.

The "dialogue" function returns a Promise, so you can add a ".then()" to the end and have code run after the dialogue has been successfully completed, or a ".catch()" if the dialogue was interrupted by something (such as walking or performing another action).

I plan to make more detailed guides on both of these systems shortly. :)

Looks good. Keep up the good work!

Quote:

---

Originally Posted by I Stig I [Only registered and activated users can see links. Click Here To Register...]

Looks good. Keep up the good work!

---

Thank you!


Update: Finally got around to adding a full update server to the project. The [Only registered and activated users can see links. Click Here To Register...] has also had the update server re-enabled to go along with this change. Seems to work fine, even with the 377 maps loaded since we packed them in properly.