Spacecraft Randomizer

Overview

The Spacecraft Randomizer is an NPM package designed to generate random values for spacecraft actions, such as battery status, active sensors, detected materials, movement states, and sleep states. This package is used to dynamically update the spacecraftStatus object in a Node.js backend (server.js).

Installation

Step 1: Install the Package

To use the Spacecraft Randomizer in your project, install it using npm:

npm install [email protected]

Usage

Importing the Package

In your server.js, import the required function from the package:

const { updateSpacecraftStatus } = require('spacecraft-randomizer');

Updating Spacecraft Status

Use the package to update the spacecraft's status with random values:

let spacecraftStatus = { batteryPercentage: 85, activeSensors: ["Temperature", "Camera"], materialsFound: ["Ironerts", "Silver"], isAsleep: false, movement: "Stationary" };

spacecraftStatus = updateSpacecraftStatus(spacecraftStatus); console.log(spacecraftStatus);

API Functions

The package provides the following functions:

getRandomBattery(): Generates a random battery percentage (0-100).

getRandomSensors(): Randomly selects active sensors from a predefined list.

getRandomMaterials(): Randomly selects materials found during exploration.

getRandomMovement(): Returns a random movement state.

getRandomSleepState(): Returns true or false to indicate whether the spacecraft is asleep.

updateSpacecraftStatus(status): Updates an existing spacecraft status object with random values.

Example Server Integration

Below is an example of how to integrate the package into an Express.js backend (server.js):

const express = require('express'); const bodyParser = require('body-parser'); const { updateSpacecraftStatus } = require('spacecraft-randomizer');

const app = express(); const PORT = 3000;

app.use(bodyParser.json()); app.use(bodyParser.urlencoded({ extended: true }));

let spacecraftStatus = { batteryPercentage: 85, activeSensors: ["Temperature", "Camera"], materialsFound: ["Ironerts", "Silver"], isAsleep: false, movement: "Stationary" };

app.get('/status', (req, res) => { res.json(spacecraftStatus); });

app.post('/action', (req, res) => { spacecraftStatus = updateSpacecraftStatus(spacecraftStatus); res.json({ message: "Spacecraft status updated.", status: spacecraftStatus }); });

app.listen(PORT, () => { console.log(Server running at http://localhost:${PORT}); });

Publishing to NPM (Optional)

If you want to publish this package to NPM:

Create an account on npmjs.com.

Log in using:

npm login

Publish the package:

npm publish

License

This package is licensed under the ISC License.