Merge pull request #118 from zurdi15/develop

v1.6.1

backend/src/config/__init__.py

@@ -7,18 +7,17 @@
 DEV_HOST: str = "0.0.0.0"
 
 # PATHS
-LIBRARY_BASE_PATH: str = "/library"
+LIBRARY_BASE_PATH: str = "/romm/library"
+ROMM_USER_CONFIG_PATH: str = "/romm/config.yml"
+SQLITE_DB_BASE_PATH: str = "/romm/database"
 HIGH_PRIO_STRUCTURE_PATH: str = f"{LIBRARY_BASE_PATH}/roms"
-ROMM_USER_CONFIG_PATH: str = f"/romm/config.yml"
-
-# ROMM RESERVED FOLDERS
-RESERVED_FOLDERS: list = ['resources', 'database']
+RESOURCES_BASE_PATH: str = "/romm/resources"
 
 # DEFAULT RESOURCES
 DEFAULT_URL_COVER_L: str = "https://images.igdb.com/igdb/image/upload/t_cover_big/nocover.png"
-DEFAULT_PATH_COVER_L: str = f"/assets/library/resources/default/cover_l.png"
+DEFAULT_PATH_COVER_L: str = f"{RESOURCES_BASE_PATH}/default/cover_l.png"
 DEFAULT_URL_COVER_S: str = "https://images.igdb.com/igdb/image/upload/t_cover_small/nocover.png"
-DEFAULT_PATH_COVER_S: str = f"/assets/library/resources/default/cover_s.png"
+DEFAULT_PATH_COVER_S: str = f"{RESOURCES_BASE_PATH}/default/cover_s.png"
 
 # IGDB
 CLIENT_ID: str = os.getenv('CLIENT_ID')

backend/src/config/config_loader.py

@@ -2,7 +2,7 @@
 import sys
 from urllib.parse import quote_plus
 
-from config import ROMM_DB_DRIVER, SUPPORTED_DB_DRIVERS, LIBRARY_BASE_PATH
+from config import ROMM_DB_DRIVER, SUPPORTED_DB_DRIVERS, SQLITE_DB_BASE_PATH
 from logger.logger import log
 
 
@@ -23,9 +23,8 @@ def get_db_engine():
             return f"mariadb+mariadbconnector://{DB_USER}:%s@{DB_HOST}:{DB_PORT}/{DB_NAME}" % quote_plus(DB_PASSWD)
 
         elif ROMM_DB_DRIVER == 'sqlite':
-            SQLITE_PATH: str = f"{LIBRARY_BASE_PATH}/database"
-            if not os.path.exists(SQLITE_PATH): os.makedirs(SQLITE_PATH)
-            return f"sqlite:////{SQLITE_PATH}/romm.db"
+            if not os.path.exists(SQLITE_DB_BASE_PATH): os.makedirs(SQLITE_DB_BASE_PATH)
+            return f"sqlite:////{SQLITE_DB_BASE_PATH}/romm.db"
 
     else:
         log.critical(f"Not supported {ROMM_DB_DRIVER} database")

backend/src/utils/fs.py

@@ -6,9 +6,7 @@
 import requests
 from fastapi import HTTPException
 
-from config import user_config, LIBRARY_BASE_PATH, HIGH_PRIO_STRUCTURE_PATH, RESERVED_FOLDERS, DEFAULT_URL_COVER_L, DEFAULT_PATH_COVER_L, DEFAULT_URL_COVER_S, DEFAULT_PATH_COVER_S
-from models.platform import Platform
-from models.rom import Rom
+from config import user_config, LIBRARY_BASE_PATH, HIGH_PRIO_STRUCTURE_PATH, RESOURCES_BASE_PATH, DEFAULT_URL_COVER_L, DEFAULT_PATH_COVER_L, DEFAULT_URL_COVER_S, DEFAULT_PATH_COVER_S
 from handler import dbh
 from logger.logger import log
 
@@ -38,7 +36,6 @@ def get_platforms() -> list[str]:
             platforms: list[str] = list(os.walk(f"{LIBRARY_BASE_PATH}/roms"))[0][1]
         else:
             platforms: list[str] = list(os.walk(LIBRARY_BASE_PATH))[0][1]
-        [platforms.remove(reserved) for reserved in RESERVED_FOLDERS if reserved in platforms]
         try:
             excluded_folders: list = user_config['exclude']['folders']
             try:
@@ -159,19 +156,19 @@ def _cover_exists(p_slug: str, file_name: str, size: str) -> bool:
     Returns
         True if cover exists in filesystem else False
     """
-    logo_path: str = f"{LIBRARY_BASE_PATH}/resources/{p_slug}/{file_name}_{size}.png"
+    logo_path: str = f"{RESOURCES_BASE_PATH}/{p_slug}/{file_name}_{size}.png"
     return True if os.path.exists(logo_path) else False
 
 
 def _get_cover_path(p_slug: str, file_name: str, size: str) -> str:
-    """Returns platform logo filesystem path
+    """Returns rom cover filesystem path adapted to frontend folder structure
     
     Args:
         p_slug: short name of the platform
         file_name: name of rom file
         size: size of the cover -> big as 'l' | small as 's'
     """
-    return f"/assets/library/resources/{p_slug}/{file_name}_{size}.png"
+    return f"{RESOURCES_BASE_PATH}/{p_slug}/{file_name}_{size}.png"
 
 
 def _store_cover(p_slug: str, file_name: str, url_cover: str, size: str) -> None:
@@ -184,7 +181,7 @@ def _store_cover(p_slug: str, file_name: str, url_cover: str, size: str) -> None
         size: size of the cover -> big as 'l' | small as 's'
     """
     cover_file: str = f"{file_name}_{size}.png"
-    cover_path: str = f"{LIBRARY_BASE_PATH}/resources/{p_slug}/"
+    cover_path: str = f"{RESOURCES_BASE_PATH}/{p_slug}/"
     sizes: dict = {'l': 'big', 's': 'small'}
     res = requests.get(url_cover.replace('t_thumb', f't_cover_{sizes[size]}'), stream=True)
     if res.status_code == 200:

changelog.md

@@ -1,21 +1,31 @@
-# v1.6.1 (_03-04-2023_)
+# v1.6.1 (_04-04-2023_)
 
 ## Added
- - Now RomM version appears in the bottom of the settings panel
+ - Now sqlite database location can be binded to ``/romm/database``. Check [docker-compose](docker/docker-compose.example.yml) example.
+ - Now resources location (games cover) can be binded to ``/romm/resources``. Check [docker-compose](docker/docker-compose.example.yml) example.
+ - More platforms support. Check [platforms support](https://github.com/zurdi15/romm#platforms-support)
 ## Fixed
  - Download feature is now fixed for RomM structucture 1
+## Changed
+ - Library path binding changed from ``/library`` to ``/romm/library``
+
+<br>
 
 # v1.6 (_01-04-2023_)
 
 ## Added
  - Smart scan: now RomM will only scan the changes in the filesystem, making the scan process too much faster. Added an option to force a full scan.
  - Now game files can be renamed after the name matched in IGDB, keeping the tags.
 
+<br>
+
 # v1.5.1 (_31-03-2023_)
 
-## Fix
+## Fixed
  - Delete game now works properly
 
+<br>
+
 # v1.5 (_30-03-2023_)
 
 **`Breaking change`**
@@ -26,26 +36,28 @@ I apologize for the inconveniences this may cause, as this is a new software, it
 
 ## Added
  - Now RomM folder structure is more flexible to match two different patrons by priority. This change makes RomM **Emudeck** compatible at least with single file games platforms. Check [folder structure](readme.md#⚠️-folder-structure)
-
- - Added config file support to exclude folders and specific extension files to be scanned. To reload config file RomM reload is needed. Check [config](readme.md#configuration).
-
+ - Added config file support to exclude folders and specific extension files to be scanned. Config file can be binded to ``/romm/config.yml`` .To reload config file RomM reload is needed. Check [config](readme.md#configuration).
  - Added tags support for region, revision/version and generic tags. Tags must have the right prefix to allow RomM scan them properly. Check [tags](readme.md#📑-tags-support).
 
+<br>
+
 # v1.4.1 (_29-03-2023_)
 
 ## Added
  - Now you can use your games tags (like (USA) or (rev-1)) to filter in the gallery
 
+<br>
+
 # v1.4 (_29-03-2023_)
 
 ## Added
  - Gamecube support [platforms support](https://github.com/zurdi15/romm#platforms-support)
-
  - PC support added (only for single file games like zip, iso, etc) [platforms support](https://github.com/zurdi15/romm#platforms-support)
-
 ## Changed
  - Now delete game only deletes it from RomM gallery. To delete it from the filesystem too you need to allow it with the checkbox.
 
+<br>
+
 # v1.3 (_29-03-2023_)
 
 ## Fixed
@@ -71,25 +83,25 @@ Columns to modify (examples in case that you set it with database name as romm,
  alter table romm.platforms modify column path_logo text;
 ```
 
+<br>
 
 # v1.2.2 (_28-03-2023_)
 
 ## Added
  - Notification added when downloading a game
-
 ## Changed
  - Database name when using mariadb now can be changed with the new variable DB_NAME. Check [docker-compos.example.yml](https://github.com/zurdi15/romm/blob/master/docker/docker-compose.example.yml)
-
 ## Fixed
  - Potential password error when using mariadb if the password have special characters
  - Some other bugs
 
+<br>
+
 # v1.2 (_28-03-2023_)
 
 ## Added
  - SQLite support
  - Dreamcast support (https://github.com/zurdi15/romm#platforms-support)
-
 ## Changed
  - SQLite is now the database by default if ROMM_DB_DRIVER is not set. Check [docker-compos.example.yml](https://github.com/zurdi15/romm/blob/master/docker/docker-compose.example.yml)
  - Platforms and games are now shown by alphabetical order
@@ -99,13 +111,11 @@ Columns to modify (examples in case that you set it with database name as romm,
 # v1.1 (_27-03-2023_)
 
 ## Added
-
  - Game names parentheses are now omitted when searching game in IGDB, allowing game names to have tags.
 
 <br>
 
 # v1.0 (_27-03-2023_)
 
 ## Added
-
 - Birth of RomM

docker/Dockerfile

@@ -10,7 +10,9 @@ RUN npm run build
 FROM ubuntu/nginx:1.18-22.04_edge as production-stage
 COPY --from=front-build-stage /front/dist /var/www/html
 COPY ./frontend/assets/platforms /var/www/html/assets/platforms
-RUN ln -s /library /var/www/html/assets/library
+RUN mkdir -p /var/www/html/assets/romm
+RUN ln -s /romm/library /var/www/html/assets/romm/library
+RUN ln -s /romm/resources /var/www/html/assets/romm/resources
 
 # setup backend
 RUN apt update 

docker/docker-compose.example.yml

@@ -14,8 +14,10 @@ services:
       - CLIENT_SECRET=<IGDB client secret>
       - STEAMGRIDDB_API_KEY=WIP
     volumes:
-      - '/path/to/library:/library'
+      - '/path/to/library:/romm/library'
+      - '/path/to/resources:/romm/resources'
       - '/path/to/config.yml:/romm/config.yml'
+      - '/path/to/database:/romm/database' # Only if ROMM_DB_DRIVER='sqlite' or ROMM_DB_DRIVER not exists 
     ports:
       - '80:80'
     depends_on:

docker/init_scripts/init_back

@@ -1,4 +1,4 @@
 #!/bin/bash
 
 cd /back
-uvicorn main:app --proxy-headers --host 0.0.0.0 --port 5000 --workers 2
+uvicorn main:app --proxy-headers --host 0.0.0.0 --port 5000 --workers 3

frontend/index.html

@@ -5,7 +5,7 @@
   <meta charset="UTF-8" />
   <link rel="icon" href="/favicon.ico" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Rom Manager</title>
+  <title>RomM</title>
 </head>
 
 <body>

frontend/src/components/Navigation.vue

@@ -139,15 +139,15 @@ getPlatforms()
         
         <!-- Desktop -->
         <!-- RomM avatar -->
-        <v-avatar class="ml-4 mr-2 hidden-md-and-down" :rounded="0"><v-img src="/assets/romm.png"></v-img></v-avatar>
+        <v-avatar class="ml-4 mr-2 hidden-md-and-down" :rounded="0"><v-img src="/assets/romm.ico"></v-img></v-avatar>
         <!-- RomM title -->
-        <v-list-item-title class="text-h6 font-weight-black ma-2 hidden-md-and-down">ROM MANAGER</v-list-item-title>
+        <v-list-item-title class="text-h6 font-weight-black ma-2 hidden-md-and-down">RomM</v-list-item-title>
 
         <!-- Mobile -->
         <!-- Platforms drawer toggle -->
         <v-app-bar-nav-icon @click="drawer = !drawer" class="ma-2 hidden-lg-and-up" rounded="0"/>
         <!-- Platform icon -->
-        <v-avatar class="ma-2 hidden-lg-and-up" :rounded="0"><v-img :src="'/assets/platforms/'+currentPlatform.slug+'.png'"></v-img></v-avatar>
+        <v-avatar class="ma-2 hidden-lg-and-up" :rounded="0" :image="'/assets/platforms/'+currentPlatform.slug+'.ico'"/>
 
         <v-spacer class="hidden-xs-and-down"></v-spacer>
 
@@ -172,7 +172,7 @@ getPlatforms()
                 @:click="selectPlatform(platform)" class="pt-4 pb-4">
                 <v-list class="text-subtitle-2">{{ rail ? '' : platform.name }}</v-list>
                 <template v-slot:prepend>
-                    <v-avatar :rounded="0"><v-img :src="'/assets/platforms/'+platform.slug+'.png'"></v-img></v-avatar>
+                    <v-avatar :rounded="0"><v-img :src="'/assets/platforms/'+platform.slug+'.ico'"></v-img></v-avatar>
                 </template>
                 <template v-slot:append>
                     <v-chip class="ml-4" size="small">{{ platform.n_roms }}</v-chip>

frontend/src/components/RomDetails.vue

@@ -86,7 +86,7 @@ async function deleteRom() {
                 <v-row>
                     <v-col>
                         <v-card >
-                            <v-img :src="rom.path_cover_l+'?reload='+Date.now()" :lazy-src="rom.path_cover_s+'?reload='+Date.now()" cover>
+                            <v-img :src="'/assets'+rom.path_cover_l+'?reload='+Date.now()" :lazy-src="'/assets'+rom.path_cover_s+'?reload='+Date.now()" cover>
                                 <template v-slot:placeholder>
                                     <div class="d-flex align-center justify-center fill-height">
                                         <v-progress-circular :width="2" :size="20" indeterminate/>

frontend/src/components/RomsGallery.vue

@@ -64,7 +64,7 @@ onMounted(() => { if(localStorage.getItem('currentPlatform')){ getRoms(JSON.pars
             <v-hover v-slot="{isHovering, props}">
                 <v-card v-bind="props" :class="{'on-hover': isHovering}" :elevation="isHovering ? 20 : 3">
                     <v-hover v-slot="{ isHovering, props }" open-delay="800">
-                        <v-img @click="selectRom(rom)" v-bind="props" :src="rom.path_cover_l+'?reload='+forceImgReload" :lazy-src="rom.path_cover_s+'?reload='+forceImgReload" class="cover" cover>
+                        <v-img @click="selectRom(rom)" v-bind="props" :src="'/assets'+rom.path_cover_l+'?reload='+forceImgReload" :lazy-src="'/assets'+rom.path_cover_s+'?reload='+forceImgReload" class="cover" cover>
                             <template v-slot:placeholder>
                                 <div class="d-flex align-center justify-center fill-height">
                                     <v-progress-circular indeterminate/>

readme.md

@@ -162,7 +162,10 @@ This will change over the time, adding games metadata for more platforms. Make s
 | poke          | poke                                | ❌             |
 | ps            | PlayStation                         | ✅             |
 | ps2           | PlayStation 2                       | ✅             |
+| ps3           | PlayStation 3                       | ✅             |
+| ps4           | ps4                                 | ❌             |
 | psp           | PlayStation Portable                | ✅             |
+| psvita        | PlayStation Vita                    | ✅             |
 | scummvm       | scummvm                             | ❌             |
 | segacd        | Sega CD                             | ✅             |
 | segasgone     | segasgone                           | ❌             |
@@ -173,6 +176,10 @@ This will change over the time, adding games metadata for more platforms. Make s
 | switch        | Nintendo Switch                     | ✅             |
 | wii           | Wii                                 | ✅             |
 | win           | PC (Microsoft Windows)              | ✅             |
+| wiiu          | Wii U                               | ✅             |
+| xbox          | Xbox                                | ✅             |
+| xbox360       | Xbox 360                            | ✅             |
+| xboxone       | Xbox One                            | ✅             |
 
 ## 📑 Tags support