Add mod descriptions

Author: Raicuparta

app/components/Mods/ModTableRow.tsx

@@ -5,6 +5,7 @@ import {
   TableRow,
   Chip,
   Tooltip,
+  Typography,
 } from '@material-ui/core';
 
 import { useRecoilValue } from 'recoil';
@@ -24,6 +25,9 @@ const useStyles = makeStyles((theme) => ({
   missingDependencyRow: {
     background: theme.palette.secondary.dark,
   },
+  modDescription: {
+    color: theme.palette.text.disabled,
+  },
 }));
 
 const ModTableRow: React.FunctionComponent<Props> = ({ mod }) => {
@@ -76,7 +80,14 @@ const ModTableRow: React.FunctionComponent<Props> = ({ mod }) => {
   return (
     <Tooltip title={getRowTooltip()}>
       <TableRow className={getClassName()} key={mod.uniqueName}>
-        <TableCell>{mod.name}</TableCell>
+        <TableCell>
+          <Typography variant="subtitle1">
+            {mod.name}
+          </Typography>
+          <Typography className={styles.modDescription} variant="caption">
+            {mod.description}
+          </Typography>
+        </TableCell>
         <TableCell>{mod.author}</TableCell>
         <TableCell align="right">{mod.downloadCount}</TableCell>
         <TableCell>

app/globals.d.ts

@@ -16,6 +16,7 @@ type Mod = {
   errors: string[];
   dependencies: string[];
   requireVR?: boolean;
+  description?: string;
 };
 
 type ModMap = { [uniqueName: string]: Mod };
@@ -38,6 +39,7 @@ type Manifest = {
   version: string;
   dependencies?: string[];
   requireVR?: boolean;
+  description?: string;
 };
 
 type ModConfig = {

app/services/get-local-mods.ts

@@ -24,6 +24,7 @@ function getOwmlSync(owmlPath: string) {
     isRequired: true,
     errors: [],
     dependencies: [],
+    description: owmlManifest?.description,
   };
   return owml;
 }
@@ -54,6 +55,7 @@ export function getLocalModsSync(owmlPath: string) {
           errors: [],
           dependencies: manifest.dependencies ?? [],
           requireVR: manifest.requireVR,
+          description: manifest.description,
         };
 
         if (missingAttributes.length > 0) {

app/services/get-mod-database.ts

@@ -62,6 +62,7 @@ export async function getModDatabase(
         repo,
         dependencies: manifest.dependencies ?? [],
         isRequired: required,
+        description: manifest.description,
       };
 
       if (missingAttributes.length > 0) {

app/services/manifest.ts

@@ -19,6 +19,7 @@ export function manifestPartialToFull(partialManifest: Partial<Manifest>) {
     version: getAttribute('version'),
     dependencies: partialManifest.dependencies ?? [],
     requireVR: partialManifest.requireVR ?? false,
+    description: partialManifest.description,
   };
 
   return {

app/static-text.ts

@@ -39,7 +39,7 @@ export const modsText = {
   findModsLabel: 'Find mods',
   emptyModList: 'No mods here! 😱',
   tableHead: {
-    name: 'Name',
+    name: 'Mod',
     author: 'Author',
     downloadCount: 'Downloads',
     version: 'Version',