T_Furcadia_IO_Paths - StarShip-Avalon-Projects/FurcadiaFramework GitHub Wiki

Paths Class

This stuff is still in the planning stages. Any questions or Comments are welcome. [This is preliminary documentation and is subject to change.]

This class contains all the paths related to the users furcadia installation. NOTICE: DO NOT REMOVE

Credits go to Artex for helping me fix Path issues and contributing his code.

NOTICE: DO NOT REMOVE.

Log Header

Format: (date,Version) AuthorName, Changes.

(Mar 12,2014,0.2.12) Gerolkae, Adapted Paths to work with a Supplied path

(June 1, 2016) Gerolkae, Added possible missing Registry Paths for x86/x64 Windows and Mono Support. Wine Support also contains these corrections.

Inheritance Hierarchy

System.Object
  Furcadia.IO.Paths
Namespace: Furcadia.IO
Assembly: FurcadiaLib (in FurcadiaLib.dll) Version: 2.19.PreAlpha 43

Syntax

C#

public class Paths

VB

Public Class Paths

VB Usage

Dim instance As Paths

C++

public ref class Paths

F#

type Paths =  class end

The Paths type exposes the following members.

Constructors

 

Name Description
Public method Paths() Load Default Furcadia Paths
Public method Paths(String) Load Paths Based on path
  Back to Top

Properties

 

Name Description
Public property CachePath Cache path - contains all the Furcadia cache and resides in the global user space.

Default: %ALLUSERSPROFILE%\Dragon's Eye Productions\Furcadia

Public property CharacterPath **Obsolete. ** Character file path - contains furcadia.ini files with login information for each character.

Default: My Documents\Furcadia\Furcadia Characters</td>

Public property DefaultCachePath c:\Program Data</td>
Public property DefaultCharacterPath **Obsolete. ** Default Character Path
Public property DefaultDreamsPath Personal Dreams Folder
Public property DefaultFurcadiaPath Default Furcadia install folder - this path is used by default to install Furcadia to.

Default: c:\Program Files\Furcadia

Public property DefaultGlobalMapsPath Main Maps Default path
Public property DefaultGlobalSkinsPath default skins
Public property DefaultLocalSkinsPath default local skins
Public property DefaultLogsPath **Obsolete. ** default personal log folder
Public property DefaultPatchPath Path to the default patch (graphics, sounds, layout) folder used to display Furcadia itself, its tools and environment.

Default: c:\Program Files\Furcadia\patches\default

Public property DefaultPermanentMapsCachePath Default Main Maps
Public property DefaultPersonalDataPath Default Documents\Furcadia
Public property DefaultPortraitCachePath Portrait cache
Public property DefaultScreenshotsPath Furcadia Screen Shots default folder
Public property DefaultSettingsPath User App Data Settings
Public property DefaultTemporaryDreamsPath Temporary dreams
Public property DefaultTemporaryFilesPath Default Temporary Files
Public property DefaultTemporaryPatchesPath Temporary patches
Public property DefaultWhisperLogsPath **Obsolete. ** Whisper Logs
Public property DreamsPath Dreams path - contains Furcadia dreams made by the player. Default: My Documents\Furcadia\Dreams
Public property FurcadiaLocaldirPath Furcadia Localdir path - this path (when explicitly set), indicates the whereabouts of the data files used in Furcadia. If localdir.ini is present in the Furcadia folder, Furcadia.exe will load those files from the specific path and not the regular ones. Default: -NONE-
Public property FurcadiaPath Furcadia install path - this path corresponds to the path where Furcadia is installed on the current machine. If Furcadia is not found, this property will be null.
Public property GlobalMapsPath Path to the global maps, distributed with Furcadia and loadable during game play in some main dreams. Default: c:\Program Files\Furcadia\maps
Public property GlobalSkinsPath Path to the global skins that change Furcadia's graphical layout. They are stored in the Furcadia program files folder. Default: c:\Program Files\Furcadia\skins
Public property LocaldirPath LocalDir path - a specific path where all the player-specific and cache data is stored in its classic form. Used mainly to retain the classic path structure or to run Furcadia from a removable disk.
Public property LocalSkinsPath Local skins path - contains Furcadia skins used locally by each user. Default: My Documents\Furcadia\Skins
Public property LogsPath **Obsolete. ** Logs path - contains session logs for each character and a sub-folder with whisper logs, should Pounce be enabled. Default: My Documents\Furcadia\Logs
Public property PermanentMapsCachePath Permanent Maps cache path - contains downloaded main maps such as the festival maps or other DEP-specific customized dreams. Default: %ALLUSERSPROFILE%\Dragon's Eye Productions\Furcadia\Permanent Maps
Public property PersonalDataPath Personal data path - contains user-specific files such as logs, patches, screen shots and character files. Default: My Documents\Furcadia</td>
Public property PortraitCachePath Portrait cache path - contains downloaded portraits and desctags cache for faster loading and bandwidth optimization. Default: %ALLUSERSPROFILE%\Dragon's Eye Productions\Furcadia\Portrait Cache
Public property ScreenshotsPath Screen shots path - contains screen shot files taken by Furcadia with the CTRL+F1 hotkey. At the time of writing, in PNG format. Default: My Documents\Furcadia\Screenshots
Public property SettingsPath Personal settings path - contains all the Furcadia settings for each user that uses it.

Default (VISTA+): %USERPROFILE%\Local\AppData\Dragon's Eye Productions\Furcadia

Public property TemporaryDreamsPath Temporary dreams path - contains downloaded player dreams for subsequent loading.

Default: %ALLUSERSPROFILE%\Dragon's Eye Productions\Furcadia\Temporary Dreams

Public property TemporaryFilesPath Temporary files path - contains downloaded and uploaded files that are either used to upload packages or download them for extraction.

Default: %ALLUSERSPROFILE%\Dragon's Eye Productions\Furcadia\Temporary Files

Public property TemporaryPatchesPath Temporary patch path - contains downloaded temporary patches. This technology is never in use, yet supported, so this folder is always empty.

Default: %ALLUSERSPROFILE%\Dragon's Eye Productions\Furcadia\Temporary Patches

Public property UsingLocaldir Has LoclDir.ini been detected?
Public property WhisperLogsPath **Obsolete. ** Whisper logs path - contains whisper logs for each character whispered, recorded by Pounce with the whisper windows. Default: My Documents\Furcadia\Logs\Whispers
  Back to Top

Methods

 

Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetDefaultPatchPath Find the path to the default patch folder on the current machine.
Public method GetFurcadiaInstallPath Find the path to Furcadia data files currently installed on this system.
Public method GetFurcadiaLocaldirPath Find the current localdir path where data files would be stored on the current machine.
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
  Back to Top

Extension Methods

 

Name Description
Public Extension Method AsDouble (Defined by ObjectExtensions.)
Public Extension Method AsInt16 (Defined by ObjectExtensions.)
Public Extension Method AsInt32 (Defined by ObjectExtensions.)
Public Extension Method AsInt64 (Defined by ObjectExtensions.)
Public Extension Method AsString (Defined by ObjectExtensions.)
  Back to Top

Remarks

Theory check all known default paths check localdir.ini

then check each registry hives for active CPU type

Then check each give for default 32bit path(Non wow6432node)

then check Wine variants(C++ Win32 client)

then check Mono Versions for before mentioned(C#? Client)

then check default drive folder paths

If all Fail... Throw FurcadiaNotFoundException exception

Clients Should check for this error and then ask the user where to manually locate Furccadia

See Also

Reference

Furcadia.IO Namespace

⚠️ **GitHub.com Fallback** ⚠️