Galaxy JS

Installation

Include GalaxyJS in your project:

<script src="js/main.js"></script>
<script src="js/animations.js"></script>
<link rel="stylesheet" href="css/animations.css">

Or install via npm:

npm install galaxyjs
# or
yarn add galaxyjs

Basic Usage

Initialize GalaxyJS and create animations:

// Initialize GalaxyJS
const galaxy = new GalaxyJS({
    debug: true,
    autoInit: true
});

// Create a pulsar animation
galaxy.animations.initPulsar('.pulsar-element', {
    frequency: 2,
    intensity: 0.8
});

// Create a black hole animation
galaxy.animations.initBlackHole('.blackhole-element', {
    eventHorizon: true,
    accretionDisk: true
});

API Reference

GalaxyJS Constructor

new GalaxyJS(options)

Options:

• debug (boolean): Enable debug logging
• autoInit (boolean): Auto-initialize on DOM ready
• particleCount (number): Default particle count
• trailLength (number): Mouse trail length

Animation Methods

All animation methods follow this pattern:

galaxy.animations.init[AnimationName](element, options)

Stellar Objects

Pulsar

galaxy.animations.initPulsar(element, {
    frequency: 2,        // Hz
    intensity: 0.8,      // 0-1
    waveCount: 3,        // Number of waves
    color: '#ffffff'     // Wave color
});

Black Hole

galaxy.animations.initBlackHole(element, {
    eventHorizon: true,      // Show event horizon
    accretionDisk: true,     // Show accretion disk
    rotationSpeed: 0.02,     // Rotation speed
    diskParticles: 50        // Number of particles
});

Neutron Star

galaxy.animations.initNeutronStar(element, {
    rotationSpeed: 0.02,     // Core rotation speed
    magneticField: true,     // Show magnetic field
    pulsarBeams: true        // Show pulsar beams
});

Supernova

galaxy.animations.initSupernova(element, {
    explosionForce: 100,     // Explosion intensity
    particleCount: 30,       // Number of particles
    duration: 3000           // Animation duration (ms)
});

Binary Stars

galaxy.animations.initBinaryStars(element, {
    orbitSpeed: 0.01,        // Orbital speed
    starSize: 12,            // Star size (px)
    orbitRadius: 30          // Orbit radius (px)
});

Solar Flare

galaxy.animations.initSolarFlare(element, {
    flareIntensity: 0.7,     // Flare intensity
    plasmaArcCount: 4,       // Number of plasma arcs
    eruptionSpeed: 0.03      // Eruption speed
});

Cosmic Phenomena

Wormhole

galaxy.animations.initWormhole(element, {
    depth: 200,              // Tunnel depth
    starCount: 20,           // Number of stars
    tunnelSpeed: 0.05        // Travel speed
});

Quasar

galaxy.animations.initQuasar(element, {
    accretionDiskSpeed: 0.03,    // Disk rotation speed
    jetStreamIntensity: 0.8,     // Jet stream intensity
    energyBurstRate: 0.1         // Burst frequency
});

Nebula

galaxy.animations.initNebula(element, {
    particleCount: 30,       // Number of particles
    cloudSize: 80,           // Cloud size (px)
    driftSpeed: 0.01         // Particle drift speed
});

Asteroid Field

galaxy.animations.initAsteroidField(element, {
    asteroidCount: 15,       // Number of asteroids
    fieldSize: 200,          // Field size (px)
    rotationSpeed: 0.01      // Rotation speed
});

Asteroid Impact

galaxy.animations.initAsteroidImpact(element, {
    impactForce: 0.8,        // Impact intensity
    debrisCount: 10,         // Number of debris pieces
    craterSize: 0.6          // Crater size multiplier
});

Cosmic Ray

galaxy.animations.initCosmicRay(element, {
    rayCount: 5,             // Number of rays
    speed: 2,                // Ray speed
    length: 50               // Ray length (px)
});

Cosmic Ray Burst

galaxy.animations.initCosmicRayBurst(element, {
    burstRate: 0.1,          // Burst frequency
    rayCount: 8,             // Number of rays
    energyWaveSpeed: 0.02    // Wave propagation speed
});

Solar Wind

galaxy.animations.initSolarWind(element, {
    particleCount: 20,       // Number of particles
    windSpeed: 3,            // Wind speed
    magneticField: true      // Show magnetic field
});

Cosmic Dust

galaxy.animations.initCosmicDust(element, {
    particleCount: 50,       // Number of particles
    driftSpeed: 0.005,       // Drift speed
    particleSize: 1          // Particle size (px)
});

Cosmic Strings

galaxy.animations.initCosmicStrings(element, {
    stringCount: 3,          // Number of strings
    vibrationSpeed: 0.02,    // Vibration speed
    stringLength: 60         // String length (px)
});

Quantum Effects

Quantum Tunneling

galaxy.animations.initQuantumTunneling(element, {
    barrierHeight: 50,       // Energy barrier height
    particleSpeed: 2,        // Particle speed
    tunnelProbability: 0.3   // Tunneling probability
});

Quantum Entanglement

galaxy.animations.initQuantumEntanglement(element, {
    entanglementStrength: 0.8,   // Entanglement strength
    particleSpinSpeed: 0.02,     // Spin speed
    fieldRadius: 30              // Field radius (px)
});

Hawking Radiation

galaxy.animations.initHawkingRadiation(element, {
    radiationRate: 5,        // Radiation frequency
    particleEnergy: 2,       // Particle energy
    evaporationSpeed: 0.01   // Evaporation speed
});

Relativity Effects

Time Dilation

galaxy.animations.initTimeDilation(element, {
    dilationFactor: 0.5,     // Time dilation factor
    clockSpeed: 0.01         // Clock tick speed
});

Gravitational Lensing

galaxy.animations.initGravitationalLensing(element, {
    lensMass: 0.8,           // Lens mass strength
    lightRayCount: 5,        // Number of light rays
    distortionStrength: 0.5  // Distortion intensity
});

Spacetime Curvature

galaxy.animations.initSpacetimeCurvature(element, {
    massStrength: 0.6,       // Mass effect strength
    fabricGridSize: 20,      // Grid size (px)
    curvatureWaves: true     // Show curvature waves
});

Gravitational Waves

galaxy.animations.initGravitationalWaves(element, {
    waveCount: 3,            // Number of waves
    waveSpeed: 2,            // Wave propagation speed
    amplitude: 20            // Wave amplitude (px)
});

Cosmic Background Effects

Dark Matter

galaxy.animations.initDarkMatter(element, {
    fieldStrength: 0.5,      // Field strength
    fieldRadius: 80,         // Field radius (px)
    visibleMatterOpacity: 0.5 // Visible matter opacity
});

Dark Energy

galaxy.animations.initDarkEnergy(element, {
    expansionRate: 0.005,    // Expansion rate
    fieldStrength: 0.6,      // Field strength
    particleCount: 20        // Number of particles
});

Cosmic Microwave Background

galaxy.animations.initCosmicMicrowave(element, {
    patternSpeed: 0.001,     // Pattern rotation speed
    temperatureVariations: true, // Show temperature variations
    noiseLevel: 0.1          // Background noise level
});

Cosmic Inflation

galaxy.animations.initCosmicInflation(element, {
    expansionRate: 0.1,      // Expansion rate
    fieldStrength: 0.8,      // Field strength
    duration: 6000           // Animation duration (ms)
});

Multiverse

galaxy.animations.initMultiverse(element, {
    universeCount: 3,        // Number of universes
    bubbleSize: 40,          // Bubble size (px)
    expansionSpeed: 0.01     // Expansion speed
});

Neutron Star

galaxy.animations.initNeutronStar(element, {
    pulseRate: 0.02,         // Pulse rate
    brightness: 0.9,         // Star brightness
    color: '#CCE0FF'         // Star color
});

Quasar

galaxy.animations.initQuasar(element, {
    coreSize: 15,            // Core size (px)
    jetLength: 60,           // Jet length (px)
    jetSpeed: 2,             // Jet animation speed
    brightness: 1.0          // Core brightness
});

Spiral Galaxy

galaxy.animations.initSpiralGalaxy(element, {
    numArms: 4,              // Number of spiral arms
    numStars: 200,           // Number of stars
    rotationSpeed: 0.01,     // Rotation speed
    spiralTightness: 0.25    // How tight the spiral is
});

Cosmic Vortex

galaxy.animations.initCosmicVortex(element, {
    particleCount: 20,       // Number of particles
    vortexSpeed: 0.05,       // Rotation speed
    radius: 35,              // Vortex radius
    color: '#C864FF'         // Particle color
});

Stellar Nursery

galaxy.animations.initStellarNursery(element, {
    cloudCount: 5,           // Number of gas clouds
    formingStars: true,      // Show forming stars
    cloudSize: 40,           // Cloud size (px)
    color: 'hsl(280, 60%, 50%)' // Cloud color
});

Quantum Field

galaxy.animations.initQuantumField(element, {
    gridSize: 5,             // Grid size (5x5)
    fluctuationSpeed: 0.05,  // Fluctuation speed
    intensity: 0.8,          // Field intensity
    color: '#9664FF'         // Field color
});

Dark Matter Web

galaxy.animations.initDarkMatterWeb(element, {
    nodeCount: 8,            // Number of nodes
    connections: 2,          // Connections per node
    webRadius: 35,           // Web radius (%)
    color: '#643296'         // Web color
});

Neutron Star Collision

galaxy.animations.initNeutronStarCollision(element, {
    collisionSpeed: 0.5,     // Approach speed
    explosionSize: 60,       // Explosion radius
    particleCount: 16,       // Debris particles
    cycleTime: 5000          // Time per cycle (ms)
});

Cosmic Storm

galaxy.animations.initCosmicStorm(element, {
    lightningFrequency: 1500, // Lightning interval (ms)
    particleCount: 15,        // Storm particles
    stormIntensity: 0.8,      // Storm intensity
    color: '#C8C8FF'          // Lightning color
});

Interstellar Travel

galaxy.animations.initInterstellarTravel(element, {
    starCount: 20,           // Number of star trails
    speed: 3,                // Travel speed
    trailLength: 30,         // Star trail length
    color: '#FFFFFF'         // Star trail color
});

Black Hole Merger

galaxy.animations.initBlackHoleMerger(element, {
    approachSpeed: 0.2,      // Orbital decay speed
    waveCount: 3,            // Gravitational waves
    mergeRadius: 0,          // Merge distance
    cycleTime: 6000          // Time per cycle (ms)
});

Cosmic Symphony

galaxy.animations.initCosmicSymphony(element, {
    barCount: 12,            // Number of sound bars
    waveSpeed: 0.1,          // Wave animation speed
    amplitude: 30,           // Bar height amplitude
    gradient: true           // Use gradient colors
});

Solar Flare

galaxy.animations.initSolarFlare(element, {
    flareInterval: 1500,     // Time between flares (ms)
    flareLength: 60,         // Flare length (px)
    flareWidth: 4,           // Flare width (px)
    color: '#FFC832'         // Flare color
});

Binary Stars

galaxy.animations.initBinaryStars(element, {
    orbitRadius: 35,         // Orbit radius
    orbitSpeed: 0.03,        // Orbital speed
    star1Color: '#FFC864',   // Primary star color
    star2Color: '#96C8FF'    // Secondary star color
});

Dwarf Planet

galaxy.animations.initDwarfPlanet(element, {
    planetSize: 12,          // Planet size (px)
    orbitRadius: 40,         // Orbit radius
    orbitSpeed: 0.02,        // Orbital speed
    color: '#C89664'         // Planet color
});

Configuration

Global configuration options:

const galaxy = new GalaxyJS({
    debug: true,             // Enable debug mode
    autoInit: true,          // Auto-initialize
    particleCount: 100,      // Default particle count
    trailLength: 20,         // Mouse trail length
    theme: 'dark',           // Theme (dark/light)
    performance: 'high'      // Performance mode
});

Advanced Usage

Custom Particle Systems

// Create custom particle system
const particleSystem = galaxy.animations.createParticleSystem(container, {
    particleCount: 200,
    gravity: 0.1,
    friction: 0.98,
    bounce: 0.8
});

// Stop the system
particleSystem.isActive = false;

Mouse Trail Effects

// Create mouse trail
const mouseTrail = galaxy.animations.initMouseTrail(container, {
    trailLength: 30,
    particleSize: 4,
    fadeSpeed: 0.95
});

Gravity Simulation

// Create gravity simulation
const gravitySim = galaxy.animations.initGravitySimulation(container, {
    bodyCount: 8,
    gravity: 0.5
});

Event Handling

// Listen for animation events
document.addEventListener('galaxyjs:initialized', (e) => {
    console.log('GalaxyJS initialized', e.detail);
});

document.addEventListener('galaxyjs:demo-click', (e) => {
    console.log('Demo clicked:', e.detail.demoType);
});

Examples

Complete Example

<!DOCTYPE html>
<html>
<head>
    <title>GalaxyJS Example</title>
    <link rel="stylesheet" href="css/animations.css">
</head>
<body>
    <div class="pulsar-animation">
        <div class="pulsar-core"></div>
        <div class="pulsar-waves"></div>
    </div>
    
    <script src="js/main.js"></script>
    <script src="js/animations.js"></script>
    <script>
        // Initialize GalaxyJS
        const galaxy = new GalaxyJS({
            debug: true,
            autoInit: true
        });
        
        // Create pulsar animation
        galaxy.animations.initPulsar('.pulsar-animation', {
            frequency: 2,
            intensity: 0.8
        });
    </script>
</body>
</html>