Skip to content

๐ŸŽฎ A locally hostable, simple, light webapp to manage online download links for videogame roms, stored in JSON file databases. ๐Ÿ“ฅ

License

Notifications You must be signed in to change notification settings

Ascaniolamp/ROMeo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

32 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
banner
A locally hostable, simple, light webapp to manage online download links for videogame roms, stored in JSON files.

โš ๏ธ Disclaimer โš ๏ธ

I have stopped working on ROMeo since I learned about RomM.

๐Ÿ“ฅ ๐Ÿ–ฅ๏ธ Install ๐Ÿ–ฅ๏ธ ๐Ÿ“ฅ

The webapp must be hosted in order to correctly fetch local files. This can be done by the use of a simple Apache2 installation.

๐Ÿ“œ Configuration ๐Ÿ“ƒ

General parameters

The configuration file must be called config.json and placed in the same directory as the app.js file. It contains multiple optional and essential configuration parameters:

Required

  • defaultConsole: String - The consoles key string value of the first console the page will load.
  • consoles: {key : String} - Keys are the console' names and their values are the paths to their respective JSON file.

Optional

The default values are used in case the parameters haven't been set.

  • styleLogos: boolean (default : true) - If set to false the download buttons won't show the website's logo.
  • maxItems: number (default : 0) - The maximum number of items to display in a single page. If set to a number smaller than one, all the items will be shown in a single page.
  • sitesLogos: {key : String} = Keys are the website's domain name (ex. "vimm.net"), values are paths to their respective logo file.
  • logoThemes: {key : String} = Keys are logo file paths, values are their themes ("dark" or "light").

Console files

Console files paths MUST be referenced in the config.json file to work, they can be placed anywhere as long as they're in the configuration file's consoles object. Every console file is actually an array of ROM items, which are objects that contain the following parameters:

  • title : The ROM's title
  • link : A URL to the ROM's download page (or to the file itself)
  • altLinks : An array of alternative download links
  • description : The ROM's description
  • release : The ROM's date of release

Every ROM with a missing title or link parameter will be marked by a yellow border. If it's missing both parameters, the border will be red instead.

Logos

The media folder contains the logo files used inside the configuration file.

TODO

  • Button to add game
  • Button to edit and update config.json
  • Button to edit and update game
  • Add support for alt-links
  • Button to search for a game
  • Button to order games alphabetically or chronologically