Fear Nexus Game Documentation

Table of Contents

• Fear Nexus Game Documentation
  • Table of Contents
  • Overview
  • Features
  • Live Demo
  • Table of Features
  • Game Mechanics
    • Player Movement
    • Shooting
    • Zombie Behavior
    • Infinite Scrolling Background
    • Scoring System
  • Known Bugs
  • Customizing the Game
    • Change Zombie Speed
    • Add New Backgrounds
    • Modify Player Appearance
    • Add New Weapons
  • Known Limitations
  • Contributing
  • Testing
    • 1. Prerequisites
    • 2. Running the Game
    • 3. Test Cases
      • Gameplay
      • UI and Responsiveness
      • Audio
      • Known Issues
    • 4. Reporting Bugs
  • Game Lore
  • FAQ
    • Q: How do I play the game?
    • Q: Can I contribute to the project?
    • Q: What browsers are supported?
    • Q: Are there plans for mobile support?
  • Support
  • How to Report Issues
  • Built With
  • Performance Tips
  • Fun Facts
  • Feedback
  • Versioning
  • Project Structure (UML-like Representation)
  • Files and Pages
    • HTML Pages
      • index.html
      • gameguide.html
      • gameplay.html
    • CSS Files
      • style.css
      • gameguide.css
      • gameplay.css
    • JavaScript Files
      • script.js
    • Text Files
      • [FEAR].txt
      • When-the-sky-learned-to-breathe-backwards.txt
    • Assets
    • Audio
  • How to Play
  • Known Issues
  • Future Enhancements
  • Built With
  • Installation
  • Development Notes
  • Credits
  • Localization
  • Security
  • License
  • Behind the Scenes
  • Bug Bounty Program
  • Contact

---

Overview

Fear Nexus is a top-down shooter game where the player controls a character to shoot zombies while avoiding being attacked. The game features infinite scrolling backgrounds, various animations for the player and zombies, and sound effects to enhance the gameplay experience.

Features

• Player Movement: Controlled via keyboard input.
• Shooting Mechanic: The player can fire bullets in bursts.
• Zombie Behavior: Zombies spawn at intervals, move toward the player, and attack upon collision.
• Infinite Terrain: Grass tiles shift seamlessly to simulate an infinite scrolling background.
• Score System: Tracks and displays the current and high scores.
• Game Over Screen: Displays when the player is overrun.
• Animated Sprites: For both the player and zombies.
• Background Music: Randomized tracks play during gameplay.

Live Demo

You can try the game live here: Fear Nexus Live Demo

Table of Features

Feature	Description
Player Movement	Controlled via keyboard input (W and S keys).
Shooting Mechanic	Aim with the mouse and shoot with the left mouse button.
Zombie Behavior	Zombies spawn and move toward the player, attacking upon collision.
Infinite Terrain	Grass tiles shift seamlessly to simulate an infinite scrolling background.
Score System	Tracks and displays the current and high scores.
Game Over Screen	Displays when the player is overrun.
Animated Sprites	Includes animations for both the player and zombies.
Background Music	Randomized tracks play during gameplay.

Game Mechanics

Player Movement

• The player can move forward (W) and backward (S) while aiming with the mouse.
• Movement speed is adjustable via the movementSpeed variable in the game logic.

Shooting

• The player can shoot bullets by clicking the left mouse button.
• Bullets are fired in the direction of the mouse pointer.
• Bullet speed and firing rate are controlled by the bulletSpeed and canShoot variables.

Zombie Behavior

• Zombies spawn at random intervals and move toward the player.
• Upon collision with the player, the game ends.
• Zombie speed increases as the game progresses.

Infinite Scrolling Background

• Grass tiles are repositioned dynamically to create the illusion of infinite terrain.
• The background scrolls based on the player's movement direction.

Scoring System

• Players earn points for each zombie eliminated.

• The high score is saved locally using the browser's localStorage API.## Known Bugs

• Bullet Collision Issue: Occasionally, bullets fail to register hits on zombies when they overlap.

• Zombie Spawn Overlap: Multiple zombies sometimes spawn in the same location.

• Performance Drops: The game may lag on older systems when too many zombies are on screen.

We are actively working to resolve these issues. If you encounter any other bugs, please report them in the GitHub Issues.

Known Bugs

• Bullet Collision Issue: Occasionally, bullets fail to register hits on zombies when they overlap.
• Zombie Spawn Overlap: Multiple zombies sometimes spawn in the same location.
• Performance Drops: The game may lag on older systems when too many zombies are on screen.

We are actively working to resolve these issues. If you encounter any other bugs, please report them in the GitHub Issues.

Customizing the Game

Fear Nexus is designed to be easily customizable. Here are some ways you can modify the game:

Change Zombie Speed

• Open script.js and locate the zombieSpeed variable.
• Adjust the value to increase or decrease zombie speed.

Add New Backgrounds

• Replace the grass.png file in the images/ folder with your own background image.
• Ensure the new image has the same dimensions for seamless scrolling.

Modify Player Appearance

• Replace the player sprite in the images/Top_Down_Survivor/ folder with your own sprite.
• Update the animation frames in the script.js file.

Add New Weapons

• Create a new weapon sprite and add it to the images/ folder.
• Update the shooting logic in script.js to include the new weapon.

Known Limitations

• The game is optimized for desktop browsers and may not work well on mobile devices.
• High zombie spawn rates may cause performance issues on older systems.
• The game currently supports only English; additional languages are planned for future updates.

Contributing

Contributions are welcome and greatly appreciated! If you have ideas, suggestions, or improvements for the Fear Nexus project, please follow these steps:

1. Fork the Repository
   Click the "Fork" button at the top of this repository to create your own copy.

2. Clone the Repository
   Clone your forked repository to your local machine using the following command:

   git clone https://github.com/your-username/FearNexus.git
   
   ## Testing
   

To ensure the Fear Nexus game works as expected, follow these steps to test the project:

1. Prerequisites

• Ensure you have the following installed:
  • A modern web browser (e.g., Chrome, Firefox, Edge).
  • A local development server (e.g., Live Server for Visual Studio Code) if testing locally.

2. Running the Game

• Option 1: Live Demo

  • Visit the Fear Nexus Live Demo to play the game directly in your browser.

• Option 2: Local Testing

  1. Clone the repository to your local machine:

     git clone https://github.com/your-username/FearNexus.git

  2. Open the project folder in Visual Studio Code or your preferred IDE.
  3. Launch a local development server (e.g., right-click index.html and select "Open with Live Server").
  4. Open the game in your browser and test its functionality.

3. Test Cases

Gameplay

• Verify that the player can move using the W and S keys.
• Ensure the player can aim and shoot using the mouse.
• Confirm that zombies spawn and move toward the player.
• Check that bullets collide with zombies and remove them.
• Test the infinite scrolling background for seamless movement.
• Verify that the score updates correctly when zombies are eliminated.
• Confirm that the "Game Over" screen appears when the player is overrun.

UI and Responsiveness

• Test the start menu and game guide for proper navigation.
• Ensure the game is responsive on different screen sizes (desktop, tablet, mobile).
• Verify that buttons and links work as expected.

Audio

• Confirm that background music plays during gameplay.
• Test sound effects for shooting, zombie deaths, and the game over event.

Known Issues

• Check if any of the Known Issues occur during testing.

4. Reporting Bugs

If you encounter any issues or bugs, please report them by opening an issue in the GitHub repository. Include the following details:

• A clear description of the issue.
• Steps to reproduce the issue.
• Screenshots or error messages (if applicable).
• Your browser and operating system details.

Game Lore

In a post-apocalyptic world overrun by the undead, you play as Zizius, a lone survivor armed with a shotgun and a will to survive. The zombies are not just mindless creatures—they are remnants of a failed experiment to harness fear as a weapon. As you fight your way through endless hordes, you uncover the truth behind the Fear Nexus, a mysterious entity controlling the undead.

Will you survive long enough to uncover the secrets of the Fear Nexus?

FAQ

Q: How do I play the game?

A: Use the W and S keys to move, the mouse to aim, and the left mouse button to shoot.

Q: Can I contribute to the project?

A: Yes! Please see the Contributing section for details.

Q: What browsers are supported?

A: The game works on modern browsers like Chrome, Firefox, and Edge.

Q: Are there plans for mobile support?

A: Mobile support is planned for future updates.

Thank you for helping improve Fear Nexus!

Support

If you like this project, consider giving it a ⭐ on GitHub or sharing it with others. You can also support the development by:

• Reporting bugs or suggesting features in the GitHub Issues.
• Contributing code or documentation (see Contributing).

How to Report Issues

If you encounter any bugs or issues, please report them by:

1. Opening an issue in the GitHub repository.
2. Including the following details:
   • A clear description of the issue.
   • Steps to reproduce the issue.
   • Screenshots or error messages (if applicable).
   • Your browser and operating system details.

We appreciate your help in improving Fear Nexus!

Built With

This project was built using the following technologies and tools:

• HTML5 - For structuring the web pages.
• CSS3 - For styling and layout design.
• JavaScript - For implementing game logic and interactivity.
• Bootstrap - For responsive design and UI components.
• Visual Studio Code - As the primary code editor.
• Live Server - For local development and testing.
• Git - For version control.
• GitHub - For hosting the repository and collaboration.

Performance Tips

• Use a modern browser like Chrome or Firefox for the best performance.
• Close unnecessary tabs or applications to free up system resources.
• Ensure your browser is updated to the latest version.
• If the game lags, try reducing the number of zombies spawned in the game settings (if applicable).

Fun Facts

• The name "Fear Nexus" was inspired by the concept of a central hub of fear in a dystopian world.
• The zombie sprites were originally designed for a different project but were repurposed for this game.
• The infinite scrolling background was one of the most challenging features to implement!

Feedback

We value your feedback! If you have suggestions, ideas, or comments, please let us know by:

• Opening an issue in the GitHub repository.
• Sending an email to dineshvanputten@outlook.com.

Versioning

This project uses Semantic Versioning for version control. For a list of available versions, see the tags on this repository.

(back to top)

Project Structure (UML-like Representation)

Files and Pages

HTML Pages

index.html

• Purpose: The start menu for the game.

• Features:

  • A "Start Game" button that links to the game guide.
  • Uses Bootstrap for styling.
  

gameguide.html

• Purpose: Provides a guide for players, including lore, controls, and character details.

• Features:

  • Describes the game's existential horror theme.
  • Lists controls with visual aids.
  • Includes lore about the main character (Zizius) and demons.
  • Contains links to start the game.
  

gameplay.html

• Purpose: The main gameplay page.

• Features:

  • Loads the game canvas and initializes the game loop.
  • Plays randomized background music.
  • Includes event listeners for user interaction.
  

CSS Files

style.css

• Purpose: Styles the start menu and game guide.
• Features:
  • Sets a background image for the start menu.
  • Styles buttons, links, and text for a cohesive design.
  • Includes responsive design for mobile devices.

gameguide.css

• Purpose: Styles the game guide page.
• Features:
  • Customizes the layout for lore, controls, and character details.
  • Adds hover effects for interactive elements.
  • Ensures compatibility with various screen sizes.

gameplay.css

• Purpose: Styles the gameplay page.
• Features:
  • Sets a background image for the game canvas.
  • Styles the canvas and ensures proper alignment.
  • Includes responsive design for smaller screens.

JavaScript Files

script.js

• Purpose: Implements the core game logic.
• Features:
  • Handles player movement, shooting, and zombie behavior.
  • Manages animations for the player and zombies.
  • Implements collision detection and scoring.
  • Creates an infinite scrolling background.
  • Plays sound effects for shooting, zombie deaths, and game over.

Text Files

[FEAR].txt

• Purpose: Contains philosophical and thematic text for the game.
• Content: Explores the concept of fear and its insignificance in the grand scheme of existence.

When-the-sky-learned-to-breathe-backwards.txt

• Purpose: Provides additional lore for the game.
• Content: A surreal story about a cosmic being and the unraveling of the world.

Assets

• Sprites:
  • Player: images/Top_Down_Survivor
    
  • Zombies: images/tds_zombie
    
• Backgrounds:
  • Grass: images/grass.png
  • Gameplay: images/gameplaybg.png
  • Start Menu: images/homebg.png
• Other Assets:
  • Bullet: images/bullet.png
    
  • Crosshair: images/crosshair097.png
    
  • Game Over Screen: images/Game Over.png
    

Audio

• Background Music:
  • Myuu-Grotesque-Fantasia.mp3
  • Myuu-Obsessions.mp3
  • Myuu-Countdown.mp3
  • Myuu-Collapse.mp3
• Sound Effects:
  • Shooting: shootaudio.mp3
  • Zombie Death: demondie.mp3
  • Game Over: gameoveraudio.mp3

How to Play

1. Movement: Use the W key to move forward and S to move backward.
2. Aim: Move the mouse to aim the shotgun.
3. Shoot: Click the left mouse button to fire.
4. Restart: Press the R key when the game is over.

Known Issues

• Bullet collision detection may fail if zombies overlap excessively.
• Restart logic could be optimized to reset game objects more efficiently.
• Performance may degrade as the number of zombies increases.

Future Enhancements

• Add power-ups and new weapons.
• Introduce multiple enemy types.
• Implement difficulty scaling.
• Add sound effects and background music.
• Improve zombie AI for varied behavior.

Built With

• HTML5
• CSS3
• JavaScript
• Bootstrap

Installation

1. Download and install Visual Studio Code.
2. Clone or download the project files into a folder named FearNexus.
3. Ensure the following files and folders are present:
   • index.html
   • style.css
   • script.js
   • images/ (containing all required assets)

Development Notes

• The project is a work in progress, with frequent updates to functionality and visuals.
• The code uses strict mode ("use strict") to enforce cleaner JavaScript coding practices.

Credits

This project uses assets and resources from the following:

• Top-Down Survivor Sprite Pack
• Zombie Sprite Pack
• Grass Background
• Crosshairs Pack
• Background music by Myuu

Special thanks to all contributors and testers who helped improve the project!

Localization

Fear Nexus currently supports English. Future updates may include support for additional languages. If you'd like to contribute translations, please see the Contributing section.

Security

If you discover any security vulnerabilities in the project, please report them responsibly by contacting dineshvanputten@outlook.com. We appreciate your help in keeping Fear Nexus secure.

License

Distributed under the MIT License. See LICENSE for more information.

Behind the Scenes

• Development Time: Fear Nexus was developed over the course of 3 months.
• Biggest Challenge: Implementing the infinite scrolling background while maintaining performance.
• Fun Fact: The zombie sprites were initially created for a different project but were repurposed for Fear Nexus.

Bug Bounty Program

Help us improve Fear Nexus by reporting bugs! If you find a critical bug, you may receive recognition in the project's changelog or a small reward. Submit your bug reports here.

Contact

Created by Dinesh van Putten

• Email: dineshvanputten@outlook.com
• LinkedIn: Dinesh van Putten

(back to top)