# stardust-gg

> interact with the stardust api over http using your favorite language - javascript! (typescript too!)

Latest version **1.0.16** (published 2022-10-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install stardust-gg
pnpm add stardust-gg
yarn add stardust-gg
bun add stardust-gg
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.16 |
| Published | 2022-10-06 |
| First published | 2022-09-28 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 139.1 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | papercatjoe |
| Keywords | stardust, cryptocurrency, evm |

## Links

- npm: https://www.npmjs.com/package/stardust-gg
- npm.io page: https://npm.io/package/stardust-gg

## Dependencies (5)

- [axios](https://npm.io/package/axios.md) ^0.27.2
- [debug](https://npm.io/package/debug.md) ^4.3.4
- [ethers](https://npm.io/package/ethers.md) ^5.6.9
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [@types/uuid](https://npm.io/package/@types/uuid.md) ^8.3.4

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 1.0.16 (latest) — 2022-10-06
- 1.0.15 — 2022-10-03
- 1.0.14 — 2022-10-03
- 1.0.13 — 2022-10-01
- 1.0.12 — 2022-09-30
- 1.0.11 — 2022-09-29
- 1.0.10 — 2022-09-29
- 1.0.9 — 2022-09-29
- 1.0.8 — 2022-09-28
- 1.0.7 — 2022-09-28

## README

# Stardust-gg

interact with the stardust api over http using your favorite language - javascript! (typescript too!)

```bash
npm i stardust-gg
yarn add stardust-gg
```

## Stardust dashboard setup

To hit the stardust api directly a few items must be completed.
- login to stardust
- create a game (preferrably an isolated one - called test) on polygon
- create an api key
- copy the api key into your `.env` file under `STARDUST_APIKEY`
- create a template called test
- copy the template id into your `.env` file under `TEMPLATE_ID`

## Create a game

```ts
// game.ts
import * as stardust from 'stardust-gg'
export const game = new stardust.Game('API_KEY_HERE')
```

## Reference the game you created

```ts
// app.ts
import { game } from './game'
main()
  .catch(console.error)

async function main() {
  await game.health.check() // { data: { status: 'OK' } }
  const { data: gameInstance } = await game.get()
  const { data: player } = await game.player.get('PLAYER_ID_HERE')
}
```

---
_Source: https://npm.io/package/stardust-gg · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._