clayschaad/MemoryGame
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #6 from clayschaad/copilot/sub-pr-5

Browse source 
Update README.md for manifest.txt-based image loading
This commit is contained in:
Claudio Schaad 2025-11-15 11:02:54 +01:00 committed by GitHub
commit 16299f02a0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 12 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -133,28 +133,22 @@ MemoryGame/
## Adding New Words/Images ## Adding New Words/Images
The game automatically discovers images from the `wwwroot/images/` folder. To add new words and images: The game loads images listed in the `wwwroot/manifest.txt` file. To add new words and images:
1. **Add your image**: Place an SVG image in `wwwroot/images/` with the English filename (e.g., `apple.svg`, `orange.svg`) 1. **Add your image**: Place an SVG image in `wwwroot/images/` with the filename (e.g., `apple.svg`, `orange.svg`)
2. **Add to discovery list**: Add the filename (without extension) to the `commonWords` array in `Services/GameService.cs`: 2. **Update the manifest**: Add the filename (with extension) to `wwwroot/manifest.txt`:
```csharp
var commonWords = new[]
{
"ball", "bed", "book", "car", "cat", "chair", "clock", "cup",
"dog", "door", "fork", "hat", "house", "knife", "phone",
"shoe", "spoon", "table", "tree", "window",
"apple", "orange" // Add new words here
};
``` ```
3. **Add German translation** (optional): If you want a custom German translation, update the `ConvertToGermanWord` method in `Services/GameService.cs`: ball.svg
```csharp bed.svg
"apple" => "Apfel", book.svg
"orange" => "Orange", apple.svg
orange.svg
``` ```
Each image filename should be on its own line in the manifest file.
If no translation is provided, the filename will be capitalized and used as-is.
The game will automatically discover and load images that exist in the folder. No manifest file needed! 3. **Image naming**: The word displayed in the game is derived from the filename without the extension (e.g., `apple.svg` becomes "Apple" in the game).
The game uses efficient parallel loading to fetch all images listed in the manifest file at startup.
## Browser Compatibility ## Browser Compatibility