Skip to content

kleineluka/roxstar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

65 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

RoxStar ๐Ÿ’Ž

Can you keep a secret?
I'm a Moshi on a mission...
I'M MISSY KIX!
The sassy secret agent slash musician!

RoxStar is a fan-made server (and client) implementation of the Moshi Monsters flash game API in NodeJS.

  • By using, copying, or modifying this software you are agreeing to the terms laid out in the License (Version 2).
  • While the server is mostly complete, this project is still in early development and not ready for general use.
  • The current version of Roxstar is 0.0.1 - you can also see a Changelog.md of notable updates and changes.

Highlights ๐ŸŒˆ

  • Client
    • Flash support on Chromium
    • Server browser and management
    • Settings, QoL, themes, and developer tools
  • Server
    • Parity with original API (WIP)
    • Fast, lightweight, secure, and configurable
    • Staff panel and moderation tools
    • Resource manifest offloading (WIP)
  • Open source with RoxStar License
  • Clean-room implementation with readable code

Parity Progress โ˜๏ธ

  • Account creation and authentication
  • User profiles and monster management
  • Friends, bestfriends, and pinboards
  • Moshling zoo and bios
  • Minigames and highscores
  • Clothing and furniture
  • Garden planting and Moshling catching
  • Mystery gift sending and opening
  • Chat and messaging
  • World and location visiting
  • Puzzle palace
  • Secret codes and rewards
  • Room system
  • Missions
  • Ratings

When development is near completion, more in-depth documentation will be provided.

Architecture ๐Ÿฆ‹๏ธ

You can find all of the server code inside of server/components/ and all of the server configuration in server/configs/. The client code is inside client/. In components, different files are broken down as follows:

  • features/ - Code for specific features such as minigame highscores.
  • middleware/ - Express middleware for handling requests.
  • requests/ - Code for handling specific API endpoints broken down by category.
  • server/ - Code for server setup and configuration.
  • staff/ - Code for staff panel and moderation tools.
  • utils/ - Utility functions and helpers used across the codebase.
  • web/ - Dynamic web pages served by the server.
  • server.js - Main server entry point and setup.

Acknowledgements ๐Ÿซถ

Releases

No releases published

Packages

 
 
 

Contributors