Repository navigation
Home
Welcome to Furcadia Frame Work for Third Party Programs.
Furcadia Framework is intended to help the community develop Third Party Applications using the .NET Framework. This library includes all the basic functionality for working with the Furcadia Client, associated programs, and services.
Copies of this document will be included as a Compiled Help File (*.chm) in each release of the SDK. All current documentation will be stored at our GitHub Repository. Alternatively, you can download this document in a Compiled Help File format here.
We're Currently working on a ProxySession Class in the Furcadia Framework Library. This Class is intended to be a drop in replacement for NetProxy and will include the bells and whistles for basic operation. To assist us in further development of the library, we have under taken a mission to document all aspects of Furcadia that we can. From file specificifications and configurations to items lists and patch information, this project intends to capture it all for both legacy and modern Furcadia.
Anyone is welcome to contribute to this project. Our aim is to support the community in any area we can. This often requires updating older documentation in the depths of the internet and bringing it to one community supported arena.
- Client to Server Queue Manager(Furcadia.Net.Utils.ServerQue ) This will Absorb all the SendToServer instructions and spoon feed them to the game server without overloading the Servers' Buffer. In here we'll handle Throat-Tired Syndrome and NoEndurance.
- Dream Patron List Manager(Furcadia.Net.Dream) This will maintain a list of players in the current dream and keep track of basic stats such as current player position, costume settings, taking advantage of DragonSpeak Parameters.
- Pounce Connection(Furcadia.Net.Pounce) Player online detection.
- Account Log-on Directly connecting to the Furcadia API using character .INI files for legacy support.
- Server to Client Instruction Handling(Furcadia.Net.Utils.ServerParser) Parsing Server data for basic Proxy operation with events leading out for custom code links. The events will return Server Data and EventArgs. This will apply to Text channel parsing as well.
- SSL/TLS Connection Handling of game server Security Certificates for an encrypted connection.
Furcadia Framework For Third Party Programs
Send comments on this topic to [Lead Developer Gerolkae](mailto:gerolkae%40hotmail.com?Subject=Furcadia Framework For Third Party Programs)
- Welcome to FFF3PP
- About
- Appendix
- FFF3PP Reference
- Furcadia Specifications
- VersionHistory
-
Furcadia Frame Work SDK
-
Furcadia.Drawing Namespaces
- Furcadia.Drawing Namespace
-
Furcadia.Drawing.Graphics Namespace
- Frame Structure
- Frame.FrameFormats Enumeration
- Frame.Pos Structure
- FurcadiaPaletteException Class
- FurcadiaShapes Class
- FurcadiaShapesException Class
- Palette Class
-
Remapper Class
- Remapper Methods
-
Remapper Fields
- Remapper.BadgeRemap Field
- Remapper.BootRemap Field
- Remapper.BracersRemap Field
- Remapper.CapeRemap Field
- Remapper.EyeRemap Field
- Remapper.FurRemap Field
- Remapper.HairRemap Field
- Remapper.MarkingsRemap Field
- Remapper.Palette Field
- Remapper.PalLoaded Field
- Remapper.TrousersRemap Field
- Remapper.VestRemap Field
- Shape Structure
- Shape.ShapeFlags Enumeration
- StepBlock Structure
- StepBlock.StepBlockStepTypes Enumeration
- Furcadia.Extensions Namespace
-
Furcadia.FurcMap Namespace
-
Map Class
- Map Constructor
-
Map Properties
- Map.AllowDreamURL Property
- Map.AllowJoinSummon Property
- Map.AllowLargeDreamSize Property
- Map.AllowLeadFollow Property
- Map.AllowShouting Property
- Map.EncodeDream Property
- Map.EnforceParentalControls Property
- Map.ForceSitting Property
- Map.Height Property
- Map.Name Property
- Map.PatchArchive Property
- Map.PreventPlayerListing Property
- Map.PreventSeasonalAvatars Property
- Map.PreventTabListing Property
- Map.Rating Property
- Map.Revision Property
- Map.UsePatch Property
- Map.UseSwearFilter Property
- Map.Width Property
-
Map Methods
- Map.GetEffectAt Method
- Map.GetFloorAt Method
- Map.GetMapPos Method
- Map.GetMapTile Method
- Map.GetObjectAt Method
- Map.GetRegionAt Method
- Map.GetWallAt Method
- Map.LoadFrom Method
- Map.Save Method
- Map.SetEffectAt Method
- Map.SetFloorAt Method
- Map.SetObjectAt Method
- Map.SetRegionAt Method
- Map.SetWallAt Method
- MapPosition Class
- MapRating Class
- MapTile Class
-
Map Class
-
Furcadia.IO Namespace
- FurcadiaIOException Class
- FurcadiaNotFoundException Class
-
IniFile Class
- IniFile Constructor
- IniFile Properties
- IniFile Methods
- IniFile.IniSection Class
- IniFile.IniSection.IniKey Class
-
Paths Class
- Paths Constructor
-
Paths Properties
- Paths.CachePath Property
- Paths.CharacterPath Property
- Paths.DefaultCachePath Property
- Paths.DefaultCharacterPath Property
- Paths.DefaultDreamsPath Property
- Paths.DefaultFurcadiaPath Property
- Paths.DefaultGlobalMapsPath Property
- Paths.DefaultGlobalSkinsPath Property
- Paths.DefaultLocalSkinsPath Property
- Paths.DefaultLogsPath Property
- Paths.DefaultPatchPath Property
- Paths.DefaultPermanentMapsCachePath Property
- Paths.DefaultPersonalDataPath Property
- Paths.DefaultPortraitCachePath Property
- Paths.DefaultScreenshotsPath Property
- Paths.DefaultSettingsPath Property
- Paths.DefaultTemporaryDreamsPath Property
- Paths.DefaultTemporaryFilesPath Property
- Paths.DefaultTemporaryPatchesPath Property
- Paths.DefaultWhisperLogsPath Property
- Paths.DreamsPath Property
- Paths.FurcadiaLocaldirPath Property
- Paths.FurcadiaPath Property
- Paths.GlobalMapsPath Property
- Paths.GlobalSkinsPath Property
- Paths.LocaldirPath Property
- Paths.LocalSkinsPath Property
- Paths.LogsPath Property
- Paths.PermanentMapsCachePath Property
- Paths.PersonalDataPath Property
- Paths.PortraitCachePath Property
- Paths.ScreenshotsPath Property
- Paths.SettingsPath Property
- Paths.TemporaryDreamsPath Property
- Paths.TemporaryFilesPath Property
- Paths.TemporaryPatchesPath Property
- Paths.UsingLocaldir Property
- Paths.WhisperLogsPath Property
- Paths Methods
-
Furcadia.Logging Namespace
- ConsoleLogOutput Class
- FileLogOutput Class
- ILogOutput Interface
- Level Enumeration
- Logger Class
- LogMessage Structure
- MultiLogOutput Class
-
Furcadia.Movement Namespace
- CharacterFlags Class
-
ColorString Class
- ColorString Constructor
-
ColorString Properties
- ColorString.Accent Property
- ColorString.Avatar Property
- ColorString.Badge Property
- ColorString.Boots Property
- ColorString.Bracers Property
- ColorString.Cape Property
- ColorString.Eye Property
- ColorString.Fur Property
- ColorString.Gender Property
- ColorString.Hair Property
- ColorString.Length Property
- ColorString.Markings Property
- ColorString.Species Property
- ColorString.Trousers Property
- ColorString.Vest Property
- ColorString.Wings Property
- ColorString Methods
- ColorString Fields
-
Furcadia.Net Namespaces
-
Furcadia.Net Namespace
- ConnectionPhase Enumeration
- INetMessage Interface
- NetChannelEventArgs Class
- NetClientEventArgs Class
- NetMessage Class
-
NetProxy Class
- NetProxy Constructor
- NetProxy Properties
- NetProxy Methods
- NetProxy Events
- NetProxy Fields
- NetProxy.ActionDelegate Delegate
- NetProxy.DataEventHandler Delegate
- NetProxy.DataEventHandler2 Delegate
- NetProxy.ErrorEventHandler Delegate
- NetProxyException Class
- NetServerEventArgs Class
- ParseChannelArgs Class
- ParseServerArgs Class
- ServerInstructionType Enumeration
- Furcadia.Net.Account Namespace
-
Furcadia.Net.DirectConnection Namespace
- ClientBase Class
- ClientBase.ActionDelegate Delegate
- ClientBase.DataEventHandler2 Delegate
- ClientBase.ErrorEventHandler Delegate
- NetConnection Class
-
Furcadia.Net.DreamInfo Namespace
- Avatar Class
- Avatar.av_DIR Enumeration
- Avatar.av_POSE Enumeration
- Avatar.Frame Structure
- Avatar.FurrePose Enumeration
- Badges Class
- Dream Class
-
Furre Class
- Furre Constructor
-
Furre Properties
- Furre.AfkTime Property
- Furre.BeekinBadge Property
- Furre.Direction Property
- Furre.FloorObjectCurrent Property
- Furre.FloorObjectOld Property
- Furre.FurreColors Property
- Furre.FurreDescription Property
- Furre.FurreID Property
- Furre.Gender Property
- Furre.Group Property
- Furre.LastPosition Property
- Furre.LastStat Property
- Furre.Level Property
- Furre.Message Property
- Furre.Name Property
- Furre.PawObjectCurrent Property
- Furre.PawObjectOld Property
- Furre.Pose Property
- Furre.Position Property
- Furre.ShortName Property
- Furre.Visible Property
- Furre.WasVisible Property
- Furre Methods
- Furre Operators and Type Conversions
-
FurreList Class
- FurreList Constructor
- FurreList Properties
- FurreList Methods
- FurreList Fields
- IDream Interface
- IFurre Interface
-
Furcadia.Net.Options Namespace
- ClientOptions Class
-
ProxyOptions Class
- ProxyOptions Constructor
-
ProxyOptions Properties
- ProxyOptions.CharacterIniFile Property
- ProxyOptions.ConnectionRetries Property
- ProxyOptions.ConnectionTimeOut Property
- ProxyOptions.FurcadiaInstallPath Property
- ProxyOptions.FurcadiaProcess Property
- ProxyOptions.LocalhostPort Property
- ProxyOptions.ProxyHost Property
- ProxyOptions.ResetSettingTime Property
- ProxyOptions.Standalone Property
- ProxyOptions Methods
- ProxyOptions Fields
- ServerOptions Class
-
Furcadia.Net.Pounce Namespace
- PounceClient Class
- PounceConnection Class
- PounceConnection.PounceResponse Delegate
- PounceFurre Class
- PounceIni Class
-
Furcadia.Net.Proxy Namespace
-
ProxySession Class
- ProxySession Constructor
-
ProxySession Properties
- ProxySession.BanishList Property
- ProxySession.BanishName Property
- ProxySession.ClientConnectPhase Property
- ProxySession.ClientStatus Property
- ProxySession.ConnectedFurre Property
- ProxySession.Dream Property
- ProxySession.HasShare Property
- ProxySession.InDream Property
- ProxySession.Player Property
- ProxySession.ServerConnectPhase Property
- ProxySession.ServerStatus Property
- ProxySession.StandAlone Property
- ProxySession.ThroatTired Property
-
ProxySession Methods
- ProxySession.Connect Method
- ProxySession.DisconnectServerAndClientStreams Method
- ProxySession.Dispose Method
- ProxySession.GetEnumInt(T) Method
- ProxySession.IsConnectedCharacter Method
- ProxySession.ParseServerChannel Method
- ProxySession.ParseServerData Method
- ProxySession.SendFormattedTextToServer Method
- ProxySession.SendToClient Method
- ProxySession.SendToServer Method
- ProxySession.TextToServer Method
- ProxySession Events
- ProxySession Fields
- ProxySession.ClientStatusChangedEventHandler Delegate
- ProxySession.DataHandler Delegate
- ProxySession.OnErrorEventHandler Delegate
- ProxySession.ProcessChannel Delegate
- ProxySession.ProcessInstruction Delegate
- ProxySession.Rep Structure
- ProxySession.ServerStatusChangedEventHandler Delegate
- ProxySession.ThroatTiredEnabled Delegate
-
ProxySession Class
-
Furcadia.Net.Utils Namespaces
-
Furcadia.Net.Utils Namespace
- CommandQueueManager Class
- CommandQueueManager.QueueEventHandler Delegate
- ServerQue Class
- ServerQue.SendServerEventHandler Delegate
- ServerQue.ThroatTiredEnabled Delegate
-
Utilities Class
- Utilities Constructor
-
Utilities Properties
- Utilities.DefaultClient Property
- Utilities.GameServerHost Property
- Utilities.GameServerIp Property
- Utilities.GameServerPort Property
- Utilities.GetEncoding Property
- Utilities.PounceServerHost Property
- Utilities.ReggistryPathMono Property
- Utilities.ReggistryPathX64 Property
- Utilities.ReggistryPathX86 Property
- Utilities Methods
- Furcadia.Net.Utils.ChannelObjects Namespace
- Furcadia.Net.Utils.ServerObjects Namespace
-
Furcadia.Net.Utils.ServerParser Namespace
- BaseServerInstruction Class
- ChannelObject Class
- DiceRolls Class
- DreamBookmark Class
- LoadDream Class
- MoveFurre Class
- RemoveAvatar Class
- SpawnAvatar Class
- UpdateColorString Class
-
Furcadia.Net.Utils Namespace
-
Furcadia.Net.Web Namespace
- IVariable Interface
-
Variable Class
- Variable Constructor
- Variable Properties
- Variable Methods
- Variable Operators and Type Conversions
- Variable Fields
- VariableEqualityComparer Class
- VariableIsConstantException Class
- WebRequests Class
- WebUtils Class
-
Furcadia.Net Namespace
-
Furcadia.Text Namespace
-
Base220 Class
- Base220 Constructor
- Base220 Methods
-
Base220 Operators and Type Conversions
- Base220.Addition Operator
- Base220.Division Operator
- Base220.Equality Operator
- Base220 Explicit Conversion (Base220 to Int16)
- Base220.GreaterThan Operator
- Base220 Implicit Conversion Operators
- Base220.Inequality Operator
- Base220.LessThan Operator
- Base220.Modulus Operator
- Base220.Multiply Operator
- Base220.Subtraction Operator
-
Base95 Class
- Base95 Constructor
- Base95 Methods
-
Base95 Operators and Type Conversions
- Base95.Addition Operator
- Base95.Division Operator
- Base95.Equality Operator
- Base95 Explicit Conversion (Base95 to UInt16)
- Base95.GreaterThan Operator
- Base95 Implicit Conversion Operators
- Base95.Inequality Operator
- Base95.LessThan Operator
- Base95.Modulus Operator
- Base95.Multiply Operator
- Base95.Subtraction Operator
- Base95 Fields
-
FurcadiaMarkup Class
- FurcadiaMarkup Constructor
- FurcadiaMarkup Methods
-
FurcadiaMarkup Fields
- FurcadiaMarkup.ChannelNameFilter Field
- FurcadiaMarkup.ChannelRegex Field
- FurcadiaMarkup.CookieToMeREGEX Field
- FurcadiaMarkup.DescFilter Field
- FurcadiaMarkup.DescTagRegex Field
- FurcadiaMarkup.DiceFilter Field
- FurcadiaMarkup.EmoteRegexFilter Field
- FurcadiaMarkup.FontChannelFilter Field
- FurcadiaMarkup.Iconfilter Field
- FurcadiaMarkup.NameFilter Field
- FurcadiaMarkup.NameRegex Field
- FurcadiaMarkup.QueryCommand Field
- FurcadiaMarkup.ShoutRegexFilter Field
- FurcadiaMarkup.UrlFilter Field
- FurcadiaMarkup.URLRegex Field
- FurcadiaMarkup.WhisperRegex Field
- FurcadiaMarkup.YouEatCookieFilter Field
- FurcadiaMarkup.YouSayFilter Field
- FurcadiaMarkup.YouShoutFilter Field
- FurcadiaMarkup.YouWhisperRegex Field
- IniParser Class
- Settings Class
-
Base220 Class
- Furcadia.Utils Namespace
-
Furcadia.Drawing Namespaces