https://github.com/lajbel/newgrounds-boom

🎖️ Newgrounds.io Kaboom plugin
https://github.com/lajbel/newgrounds-boom

Last synced: about 2 months ago
JSON representation

🎖️ Newgrounds.io Kaboom plugin

• Host: GitHub
• URL: https://github.com/lajbel/newgrounds-boom
• Owner: lajbel
• Created: 2021-09-02T18:49:59.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-10-04T13:19:26.000Z (about 2 years ago)
• Last Synced: 2024-04-24T15:42:54.987Z (8 months ago)
• Language: JavaScript
• Homepage: https://npmjs.com/newgrounds-boom
• Size: 103 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Kaboom x Newgrounds.io

With this [Kaboom](https://github.com/replit/kaboom) plugin you can use medals and post scores on [Newgrounds.com](https://newgrounds.com)

## Quick example

```.js

import newgroundsPlugin from "newgrounds-boom";

kaboom({

    width: 500,

    height: 500,

    plugins: [ newgroundsPlugin ]

});

ngInit("52924:fdddr5yP", "oEZ7GGD79Wht9upZ4HH7Dw==", 1);

ngUnlockMedal(65025);

add([

    text("ohhi " + String(ngUsername()), {size: 40, width: 400}),

    origin("center"),

    pos(width() / 2, height() / 2)

]);

onKeyPress("space", () => {

    add([

        text(String(ngVersion()), {size: 30}),

        origin("center"),

        pos(width() / 2, height() - 80)

    ]);

});

onMouseDown(() => {

    ngUnlockMedal(65022);

    ngPostScore(10739, rand(0, 9999).toString());

});

```

## How to use

### Init

In your project, activate the "api tools" and you will see the following credentials

![](https://imgur.com/l4W6YAV.png)

Before using the newgrounds features, you'll need to connect your game, use `ngInit("App ID", "Encryption Key")`. You can activate the debug mode, which will return the results by console (cool if you have not yet published your game), use `ngInit("App ID", "Encryption Key", 1);`

Using the credentials of this game, it would be like this:

```.js

ngInit("52924:fdddr5yP", "oEZ7GGD79Wht9upZ4HH7Dw==");

```

### Unlock Medals

Once you have done the previous step, you can use the scores and medals. Let's see the medals, for that you must first have a medal, duh

![](https://imgur.com/VwzxtXn.png)

We will use the `ngUnlockMedal("Medal ID in Number")` function

```.js

ngUnlockMedal(65022);

```

### Post Scores

Now, to use the scoreboards, again, we have to have a scoreboard **duh**

![](https://imgur.com/ySpdtn3.png)

We will use the `ngPostScore("Board ID in Number", "score")` function

```.js

ngPostScore(10739, 1234);

```

### Use global types

If you want to load the global types for use as other global Kaboom Functions, you can import from "load"

```js

import "newgrounds-boom/global";

```

### Other functions

`ngUsername()`: returns a String with the newgrounds username of the player 


`ngVersion()`: returns a Number with the version of the newgrounds app 


`ngIsSupporter()`: returns a Boolean with the status of newgrounds **Support** player 


## Install

-   NPM: `npm i newgrounds-boom`

-   CDN: [jsdelivr](https://cdn.jsdelivr.net/gh/lajbel/newgrounds-boom/src/newgrounds.mjs) or [unpkg](https://unpkg.com/newgrounds-boom@latest/src/newgrounds.mjs)

-   Kaboom-Util: `npm i kaboom-util` -> `import { newgroundsPlugin } from "kaboom-util";`