Mantis Bug Tracker

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0000148Mana ClientCorepublic2010-06-04 15:302010-07-11 18:25
ReporterBertram 
Assigned ToBertram 
PrioritynormalSeverityminorReproducibilityN/A
StatusresolvedResolutionfixed 
PlatformOSOS Version
Product Version1.0.0 
Target Version1.0.0Fixed in Version1.0.0 
Summary0000148: Add the paths.xml file to take care about core relative paths and files.
DescriptionTaken from the IRC talk with Jaxad. Here is how we decided to handle this:
The paths.xml file will tell the default path for each kind of file, and add the path for the error files.
For instance:
<configuration>
 <option name="spriteRoot" value="data/graphics/sprites" />
 <option name="itemsRoot" value="data/graphics/items" />
 <option name="wallpapersRoot" value="data/graphics/gui/wallpapers" />
 <!-- ... -->
</configuration>
Additional InformationThe error files will be put back with client code as their parts of core config files - but can be overwritten by update data for customisation purpose.

The paths.xml file will be handled as a configuration file and be loaded as a new Configuration object.
The paths.xml itself will be part of client repository as a core file.
TagsNo tags attached.
Attached Filespatch file icon 0001-Made-the-different-hard-coded-paths-and-files-be-now.patch [^] (31,336 bytes) 2010-07-09 18:09 [Show Content]
xml file icon paths.xml [^] (2,024 bytes) 2010-07-09 18:10

- Relationships
related to 0000170resolvedBertram Mana Configuration defaults centralization. 

-  Notes
(0000515)
Jaxad0127 (administrator)
2010-06-04 19:39

After thinking about this some, instead of including a default file with the client, we can hardcode the backup paths, then try to read the file for new ones. This allows servers to change only a few paths if they want without needing the whole file.
(0000521)
Bertram (developer)
2010-06-18 13:11

Added a patch resolving it, awaiting for review.
(0000522)
Kage (developer)
2010-06-19 16:08

<option name="pathsXml" value="data/paths.xml" />
(0000524)
Bertram (developer)
2010-06-19 16:27

@Kage: Recursive humor?
(0000525)
Kage (developer)
2010-06-19 16:47

@Bertram: Its just I don't see the need to soft code these values... If we really want to go this route though, I would suggest making it part of the branding file.
(0000530)
Bertram (developer)
2010-06-20 17:51

Kage, please have a talk with Jaxad as this issue was thoroughly specified before entering the development phase.
If there's still something to change, then I'll see.
(0000531)
Jaxad0127 (administrator)
2010-06-21 02:01

Kage: these are for world data. Having them in branding would complicate everything, unless we distribute branding with world data and require it.

Bertram: please remove the paths that aren't part of world data. Those can remain hard-coded or put into branding.
(0000533)
Bertram (developer)
2010-06-21 06:54

Do you mean those?
<option name="defaultFontsPath" value="fonts/" />
<option name="defaultGuiThemePath" value="graphics/gui/" />
<option name="defaultHelpPath" value="help/" />
<option name="defaultIconsPath" value="icons/" />
<option name="defaultWallpaperPath" value="graphics/images/" />
<option name="defaultWallpaperFile" value="login_wallpaper.png" />

"Those can remain hard-coded or put into branding."
-> Please, no hard-code for a generic client. Branding or paths. What do you both think the best would be?
(0000535)
Jaxad0127 (administrator)
2010-06-21 15:38

Put wallpaper in both. The rest you listed just for branding. Let's avoid issues where branding and world data conflict and prevent files from being found (ie, world data changing gui location and preventing gui files from being loaded).

The gui path is troublesome, since you can easily make the gui unusable because files can't be found (branding changes it, but doesn't provide files) or some new ones are missing. If we hardcode the backup gui path, we can avoid these issues.
(0000540)
Bertram (developer)
2010-06-22 17:17
edited on: 2010-06-22 17:17

I upgraded the patch as requested.

The default gui path is sequentially searched into the branding file, and in the paths.xml file, with the hard-coded fallback.
And so it is for the default wallpaper path and file.

(0000544)
Jaxad0127 (administrator)
2010-06-22 18:47

No gui in paths.xml. It'll only cause issues.
(0000546)
Bertram (developer)
2010-06-22 20:27

Patches updated!
(0000636)
Bertram (developer)
2010-07-09 18:11

Patch updated again with asked changes from Jaxad. Please review.
(0000642)
Bertram (developer)
2010-07-11 18:24

First client paths handling pushed as:
http://www.gitorious.org/mana/mana/commit/abde0f51b3062c158fb52e9dfff23d21d3be03d1 [^]

First paths.xml version pushed as:
http://gitorious.org/tmwdata/mainline/commit/f5dd1c2e1378e7b1572c3a48887c7e3403eb95fe [^]

Issue resolved.

- Issue History
Date Modified Username Field Change
2010-06-04 15:30 Bertram New Issue
2010-06-04 15:30 Bertram Status new => assigned
2010-06-04 15:30 Bertram Assigned To => Bertram
2010-06-04 19:39 Jaxad0127 Note Added: 0000515
2010-06-18 13:11 Bertram File Added: 0001-Made-the-different-hard-coded-paths-and-files-be-now.patch
2010-06-18 13:11 Bertram Note Added: 0000521
2010-06-19 16:08 Kage Note Added: 0000522
2010-06-19 16:27 Bertram Note Added: 0000524
2010-06-19 16:47 Kage Note Added: 0000525
2010-06-20 17:51 Bertram Note Added: 0000530
2010-06-21 02:01 Jaxad0127 Note Added: 0000531
2010-06-21 06:54 Bertram Note Added: 0000533
2010-06-21 15:38 Jaxad0127 Note Added: 0000535
2010-06-22 16:41 Bertram File Deleted: 0001-Made-the-different-hard-coded-paths-and-files-be-now.patch
2010-06-22 16:41 Bertram File Added: 0001-Made-the-different-hard-coded-paths-and-files-be-now.patch
2010-06-22 16:42 Bertram File Deleted: 0001-Made-the-different-hard-coded-paths-and-files-be-now.patch
2010-06-22 17:16 Bertram File Added: 0001-Made-the-different-hard-coded-paths-and-files-be-now.patch
2010-06-22 17:17 Bertram Note Added: 0000540
2010-06-22 17:17 Bertram Note Edited: 0000540 View Revisions
2010-06-22 18:47 Jaxad0127 Note Added: 0000544
2010-06-22 20:27 Bertram File Deleted: 0001-Made-the-different-hard-coded-paths-and-files-be-now.patch
2010-06-22 20:27 Bertram File Added: 0001-Made-the-different-hard-coded-paths-and-files-be-now.patch
2010-06-22 20:27 Bertram Note Added: 0000546
2010-07-09 18:09 Bertram File Deleted: 0001-Made-the-different-hard-coded-paths-and-files-be-now.patch
2010-07-09 18:09 Bertram File Added: 0001-Made-the-different-hard-coded-paths-and-files-be-now.patch
2010-07-09 18:10 Bertram File Added: paths.xml
2010-07-09 18:11 Bertram Note Added: 0000636
2010-07-11 18:21 Bertram Relationship added related to 0000170
2010-07-11 18:24 Bertram Note Added: 0000642
2010-07-11 18:24 Bertram Status assigned => resolved
2010-07-11 18:24 Bertram Fixed in Version => 1.0.0
2010-07-11 18:24 Bertram Resolution open => fixed
2010-07-11 18:25 Bertram Status resolved => feedback
2010-07-11 18:25 Bertram Resolution fixed => reopened
2010-07-11 18:25 Bertram Status feedback => resolved
2010-07-11 18:25 Bertram Resolution reopened => fixed
2010-07-11 18:25 Bertram Target Version => 1.0.0


Copyright © 2000 - 2010 MantisBT Group
Powered by Mantis Bugtracker