LAB-linuxserver/emulatorjs
1
0
Fork 0
mirror of https://github.com/linuxserver/emulatorjs.git synced 2026-02-23 00:01:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

add metadata page to show custom metadata to user

Browse Source
This commit is contained in:
thelamer 2022-02-19 14:01:21 -08:00
parent 58b36683ec
commit f49adf73cf
3 changed files with 104 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
index.js
View File

@ -28,6 +28,7 @@ if (fs.existsSync('/data')) {
};
var configPath = dataRoot + 'config/';
var hashPath = dataRoot + 'hashes/';
var metaPath = dataRoot + 'metadata/';
var defaultPeer = '/ip4/206.189.169.226/tcp/4001/p2p/12D3KooWHRqeK6as7tbuoaQdoTUNayUQzfY5aUtTa9GpYzdWNPqU';
var metaVariables = [
['vid', 'videos', '.mp4'],
@ -95,6 +96,14 @@ io.on('connection', async function (socket) {
var files = await fsw.readdir(configPath);
socket.emit('renderconfigs', files);
};
// Send MetaData list to client
async function renderMeta() {
await fsw.mkdir(metaPath, { recursive: true });
var files = await fsw.readdir(metaPath);
socket.emit('rendermeta', files);
};
// Send rom directories to client
async function renderRomsDir() {
let dirData = [];
@ -110,6 +119,7 @@ io.on('connection', async function (socket) {
socket.emit('renderromsdir', dirData);
};
};
// Tell client to render rom scanners
async function renderRoms() {
var romData = {}
@ -141,22 +151,33 @@ io.on('connection', async function (socket) {
renderRomsDir();
socket.emit('renderromslanding', romData);
};
// Tell client to render landing
function renderLanding() {
socket.emit('renderlanding');
};
// Send file contents to client
async function getConfig(file) {
var file = file + '.json';
var fileContents = await fsw.readFile(configPath + file, 'utf8');
file = file + '.json';
let fileContents = await fsw.readFile(configPath + file, 'utf8');
socket.emit('renderconfig', JSON.parse(fileContents));
};
// Send meta contents to client
async function getMetaJSON(file) {
file = file + '.json';
let fileContents = await fsw.readFile(metaPath + file, 'utf8');
socket.emit('rendermetajson', JSON.parse(fileContents));
};
// Save sent config file
async function saveConfig(data) {
var fileName = data.name + '.json';
configFile = JSON.stringify(data.config, null, 2);
await fsw.writeFile(configPath + fileName, configFile);
};
// Organize rom data to send to client
async function getRoms(dir) {
let metaData = await getMeta(dir);
@ -225,10 +246,12 @@ io.on('connection', async function (socket) {
};
return '';
};
// Set default ipfs peer if DL times out
async function ipfsDefaultPeer() {
await ipfs.swarm.connect(defaultPeer);
};
// Download default files for user directory
async function dlDefaultFiles() {
var metaData = await fsw.readFile('./metadata/default_files.json', 'utf8');
@ -256,6 +279,7 @@ io.on('connection', async function (socket) {
socket.emit('modaldata', 'Downloaded All Files');
renderRoms();
};
// Scan roms directory using helper script
function scanRoms(data) {
let folder = data[0];
@ -279,6 +303,7 @@ io.on('connection', async function (socket) {
}
});
};
// Add roms to config file
async function addToConfig(dir, render) {
// For arcade roms we need clone info
@ -424,12 +449,12 @@ io.on('connection', async function (socket) {
// Set user linked metadata
async function userMeta(data) {
await fsw.mkdir(dataRoot + 'metadata', { recursive: true })
await fsw.mkdir(metaPath, { recursive: true });
let romSha = data[0];
let linkSha = data[1];
let dir = data[2];
if (fs.existsSync(dataRoot + 'metadata/' + dir + '.json')) {
var metaData = await fsw.readFile(dataRoot + 'metadata/' + dir + '.json', 'utf8');
if (fs.existsSync(metaPath + dir + '.json')) {
var metaData = await fsw.readFile(metaPath + dir + '.json', 'utf8');
var metaData = JSON.parse(metaData);
} else {
var metaData = {};
@ -438,21 +463,21 @@ io.on('connection', async function (socket) {
link[romSha] = {'ref': linkSha};
Object.assign(metaData, link);
userMetadataFile = JSON.stringify(metaData, null, 2);
await fsw.writeFile(dataRoot + 'metadata/' + dir + '.json', userMetadataFile);
await fsw.writeFile(metaPath + dir + '.json', userMetadataFile);
getRoms(dir);
};
// Remove user linked metadata
async function removeMeta(data) {
await fsw.mkdir(dataRoot + 'metadata', { recursive: true })
await fsw.mkdir(metaPath, { recursive: true });
let romSha = data[0];
let dir = data[1];
let file = data[2];
let purge = data[3];
let fileExtension = path.extname(file);
let name = path.basename(file, fileExtension);
if (fs.existsSync(dataRoot + 'metadata/' + dir + '.json')) {
var metaData = await fsw.readFile(dataRoot + 'metadata/' + dir + '.json', 'utf8');
if (fs.existsSync(metaPath + dir + '.json')) {
var metaData = await fsw.readFile(metaPath + dir + '.json', 'utf8');
var metaData = JSON.parse(metaData);
} else {
var metaData = {};
@ -460,7 +485,7 @@ io.on('connection', async function (socket) {
if (metaData.hasOwnProperty(romSha)) {
delete metaData[romSha];
userMetadataFile = JSON.stringify(metaData, null, 2);
await fsw.writeFile(dataRoot + 'metadata/' + dir + '.json', userMetadataFile);
await fsw.writeFile(metaPath + dir + '.json', userMetadataFile);
}
// Delete any downloaded or uploaded art
for await (let variable of metaVariables) {
@ -491,8 +516,8 @@ io.on('connection', async function (socket) {
async function getMeta(dir) {
let metaDataRaw = await fsw.readFile('./metadata/' + dir + '.json', 'utf8');
let metaData = JSON.parse(metaDataRaw);
if (fs.existsSync(dataRoot + 'metadata/' + dir + '.json')) {
let userMetaDataRaw = await fsw.readFile(dataRoot + 'metadata/' + dir + '.json', 'utf8');
if (fs.existsSync(metaPath + dir + '.json')) {
let userMetaDataRaw = await fsw.readFile(metaPath + dir + '.json', 'utf8');
let userMetaData = JSON.parse(userMetaDataRaw);
metaData = merge(metaData, userMetaData);
};
@ -636,8 +661,8 @@ io.on('connection', async function (socket) {
let cid = ipfsRes.path;
await ipfs.pin.add(cid);
// Build and write custom metadata
if (fs.existsSync(dataRoot + 'metadata/' + dir + '.json')) {
let rawMetaData = await fsw.readFile(dataRoot + 'metadata/' + dir + '.json', 'utf8');
if (fs.existsSync(metaPath + dir + '.json')) {
let rawMetaData = await fsw.readFile(metaPath + dir + '.json', 'utf8');
var metaData = JSON.parse(rawMetaData);
} else {
var metaData = {};
@ -646,7 +671,7 @@ io.on('connection', async function (socket) {
metaUpdate[hash] = {};
metaUpdate[hash][fileType] = cid;
metaData = merge(metaData, metaUpdate);
await fsw.writeFile(dataRoot + 'metadata/' + dir + '.json', JSON.stringify(metaData, null, 2));
await fsw.writeFile(metaPath + dir + '.json', JSON.stringify(metaData, null, 2));
// Write actual file
if (fileType == 'vid') {
var extension = '.mp4';
@ -675,8 +700,8 @@ io.on('connection', async function (socket) {
let hash = data[2];
let position = data[3];
// Build and write custom metadata
if (fs.existsSync(dataRoot + 'metadata/' + dir + '.json')) {
let rawMetaData = await fsw.readFile(dataRoot + 'metadata/' + dir + '.json', 'utf8');
if (fs.existsSync(metaPath + dir + '.json')) {
let rawMetaData = await fsw.readFile(metaPath + dir + '.json', 'utf8');
var metaData = JSON.parse(rawMetaData);
} else {
var metaData = {};
@ -685,18 +710,18 @@ io.on('connection', async function (socket) {
metaUpdate[hash] = {};
metaUpdate[hash].video_position = position;
metaData = merge(metaData, metaUpdate);
await fsw.writeFile(dataRoot + 'metadata/' + dir + '.json', JSON.stringify(metaData, null, 2));
await fsw.writeFile(metaPath + dir + '.json', JSON.stringify(metaData, null, 2));
getRomData([dir, file]);
}
// Create a custom metadata entry
async function customMeta(data) {
await fsw.mkdir(dataRoot + 'metadata', { recursive: true })
await fsw.mkdir(metaPath, { recursive: true });
let romSha = data[0];
let dir = data[1];
let name = data[2];
if (fs.existsSync(dataRoot + 'metadata/' + dir + '.json')) {
var metaData = await fsw.readFile(dataRoot + 'metadata/' + dir + '.json', 'utf8');
if (fs.existsSync(metaPath + dir + '.json')) {
var metaData = await fsw.readFile(metaPath + dir + '.json', 'utf8');
var metaData = JSON.parse(metaData);
} else {
var metaData = {};
@ -704,7 +729,7 @@ io.on('connection', async function (socket) {
metaData[romSha] = {};
metaData[romSha].name = name;
userMetadataFile = JSON.stringify(metaData, null, 2);
await fsw.writeFile(dataRoot + 'metadata/' + dir + '.json', userMetadataFile);
await fsw.writeFile(metaPath + dir + '.json', userMetadataFile);
getRoms(dir);
}
@ -713,6 +738,7 @@ io.on('connection', async function (socket) {
socket.on('renderroms', renderRoms);
socket.on('renderromsdir', renderRomsDir);
socket.on('getconfig', getConfig);
socket.on('getmeta', getMetaJSON);
socket.on('getroms', getRoms);
socket.on('saveconfig', saveConfig);
socket.on('dldefaultfiles', dlDefaultFiles);
@ -730,6 +756,7 @@ io.on('connection', async function (socket) {
socket.on('updatevidposition', updateVidPosition);
socket.on('removemeta', removeMeta);
socket.on('custommeta', customMeta);
socket.on('rendermeta', renderMeta);
// Render landing page
if (fs.existsSync(dataRoot + 'config/main.json')) {
renderRoms();

9
public/index.html
View File

@ -11,6 +11,7 @@
<div onclick="renderConfigss()" class="top-item">Config Management</div>
<div onclick="renderFiles()" class="top-item">File Management</div>
<div onclick="renderProfile()" class="top-item">Profile Management</div>
<div onclick="renderMeta()" class="top-item">Custom Metadata</div>
</div>
<div id="nav-buttons" class="nav-buttons"></div>
</div>
@ -151,6 +152,14 @@
<h1>Choose a folder. Drag and drop files or right click to upload.</h1>
</div>
</div>
<div id="metainfo" class="hidden">
<div class="readme">
<h2>Custom Metadata</h2>
<p>When you identify roms or upload custom artwork from the rom management interface all of that data is stored as custom metadata in your container. You can see the systems you have put the work into either skinning or identifying on the left. On top of that when you upload custom art assets from this web interface those items are added to the local IPFS server running in this Docker container. To share this data with the world you will need to forward port 4001 to a public IP address.</p>
<h2>Help us out</h2>
<p>You went through the process of linking up roms and cleaning up the artwork the way you like it, odds are another person would appreciate not doing the same work you did. If you are able to please share your metadata to <a href="https://github.com/linuxserver/emulatorjs/issues">GitHub</a> or hop on our <a href="https://discord.gg/YWrKVTn">Discord Server</a> and share it there. We can help with file optimization and getting stuff pinned to IPFS permanently. Just copy and paste the metadata to something like <a href="https://www.textdrop.link/">Text Drop</a> or <a href="https://pastebin.com/">Paste Bin</a>.</p>
</div>
</div>
<script src="socket.io/socket.io.js"></script>
<script src="public/js/vendor/jquery.min.js"></script>
<script src="public/js/vendor/ace.js"></script>

46
public/js/index.js
View File

@ -27,6 +27,10 @@ socket.on('renderfiledirs', renderFileDirs);
socket.on('renderprofiles', renderProfiles);
// Render in rom data
socket.on('romdata', renderRomData);
// Render in custom metadata page
socket.on('rendermeta', renderMetaPage);
// Render meta JSON
socket.on('rendermetajson', renderMetaJSON);
//// Functions ////
// Grab a json file from the server
@ -37,6 +41,14 @@ function getConfig(file) {
socket.emit('getconfig', file);
}
// Grab a json file from the server
function getMeta(file) {
$('#main').empty();
$('#main').append('<div class="loader"></div>');
$('#main').data('name', file);
socket.emit('getmeta', file);
}
// Get list of rom shas to process
function getRomShas(dir) {
$('#main').empty();
@ -50,6 +62,11 @@ function renderConfigss() {
socket.emit('renderconfigs');
}
// Render meta page
function renderMeta() {
socket.emit('rendermeta');
}
// Render profiles page
function renderProfile() {
socket.emit('renderprofiles');
@ -144,6 +161,19 @@ function renderConfigs(files) {
$('#main').append($('<h1>').addClass('readme').text('Open a config to edit (main for landing page)'));
}
// Render meta file list
function renderMetaPage(files) {
$('#main').empty();
$('#main').append($('#metainfo').html());
$('#side').empty();
$('#nav-buttons').empty();
$.each(files, function(index, file) {
var file = file.replace('.json','');
var sideLink = $('<div>').addClass('sideitem hover').attr('onclick', "getMeta('" + file + "')").text(file);
$('#side').append(sideLink);
});
}
// Render Roms file list
function renderRomsDir(dirs) {
$('#side').empty();
@ -214,6 +244,22 @@ async function renderConfig(config) {
editor.setValue(json, -1);
}
// Render in a config file
async function renderMetaJSON(meta) {
// Main edit window
$('#main').empty();
$('#main').append($('<div>').attr('id', 'editor'));
editor = ace.edit('editor');
editor.setTheme('ace/theme/chrome');
editor.session.setMode('ace/mode/json');
editor.$blockScrolling = Infinity;
editor.setOptions({
readOnly: false,
});
var json = JSON.stringify(meta, null, 2);
editor.setValue(json, -1);
}
// Render in roms data
async function renderRom(data) {
$('#main').empty();