Background

RGBirdflop NPM Package Documentation

RGBirdflop NPM Package

This package is used to generate RGB gradient text for Minecraft without having to make API calls and is the most recommended way to use RGBirdflop in your projects.

Installation

To install the RGBirdflop NPM package, use the following command:

npm install @birdflop/rgbirdflop

Usage

Here is a basic example of how to use the RGBirdflop NPM package:

import { rgbDefaults, generateOutput } from '@birdflop/rgbirdflop';
 
function getOutput(options: Partial<typeof rgbDefaults>) {
  const mergedOptions = {
    ...rgbDefaults,
    ...options,
  };
 
  const output = generateOutput(mergedOptions);
  return output;
}
 
const result = getOutput({
  colors: [
    { hex: '#ff0000', pos: 0 },
    { hex: '#00ff00', pos: 50 },
    { hex: '#0000ff', pos: 100 },
  ],
  text: 'Hello, World!',
  bold: true,
});
 
console.log(result);
CodeFactor

Contributing

All contributions are welcome. Birdflop is a community-project aiming to support its community.

Setting up a Local Development Environment

To contribute to RGBirdflop, you'll need to set up a local development environment as your testing ground.

Prerequisites

  • Node.js (version 24.13.0 or higher)
  • pnpm package manager

Steps to Set Up

  1. Clone the Repository: Fork the Birdflop website repository on GitHub https://github.com/birdflop/web and clone it
  2. Install Dependencies: Navigate to the project directory and run pnpm install to install all necessary dependencies.
  3. Build the Project: Run pnpm build.pkg to build the RGBirdflop package.
  4. Run the Development Server: Start the development server with pnpm start. The website should now be accessible at http://localhost:5173.

Thank you to our Contributors

Contributors

Forking & Licensing

If you are hosting this site or a single page from this site for your server or own project, please credit the original in some way. A link to the original GitHub is sufficient. <3 This project is dual-licensed. For open-source usage, it is available under the AGPL-3.0 license (OSS_LICENSE.md). Additional closed-source use, both commercial and non-commercial, is permitted under the details outlined in CSS_LICENSE.md. Licensing is required to re-use the RGBirdflop / RGB Birdflop gradient creator code.



Star History Chart

Contributors

Thank you to everyone who has helped us improve our documentation!

saboooorsaboooor