fodev.net
FOnline Development => General Discussion => Topic started by: Bartosz on December 06, 2012, 10:25:08 am
-
Hello,
As of rev383 of the SDK I decided to commit the files of the (rather big) functionality I've been working on lately: embedding Mono runtime (http://mono-project.com/) in the server to allow write scripts in .NET languages.
The files are placed under Server/mono directory and do not affect the current state of SDK. They're meant for testing purposes (the work done was rather large, and sometimes tedious, many bugs could slipped in).
Instructions
To try it out, follow the steps:
1. Replace your FOnlineServer.exe and FOnlineServer.pdb files with the one from mono directory.
2. Check the mono/FOnlineServer.cfg file and copy the lines from # Mono runtime section, most importantly:
MonoEnabled=1
MonoLibDir=mono/lib
The rest is optional.
3. Use either Visual Studio or MonoDevelop to build the provided solution file: mono/FOnline.Mono.sln. The resulting files will be copied to Server directory.
4. Run the server, you should see some mono related messages, most notably 'Initializing mono' and 'Init from mono!' that will tell you everything is OK.
Debugging
There are several ways you can debug your code (and even aid in debugging AS code).
REPL console:
It's possible to start server with console that is evaluating C# statements on the fly. Just add -mono_repl to your server command line.
(https://i.imgur.com/WoamP.png) (http://imgur.com/WoamP)
Line-by-line debugging with MonoDevelop' Soft Debugger:
1. Fetch mono runtime (latest version is 3.0.2, the server currently is integrated with 3.0.1, it should work fine) from their download page (http://www.go-mono.com/mono-downloads/download.html).
2. Install it.
3. Fetch MonoDevelop (http://monodevelop.com/), install it, and before starting, set MONODEVELOP_SDB_TEST environment variable to 1.
4. Now, start MonoDevelop, go to Tools->Options->.NET runtimes and add the one you've installed in step 2. Mark it as default.
5. Open FOnline.Mono.sln, place some breakpoint and choose Run->Run with...->Custom Command Mono Soft Debugger and enter the path to FOnlineServer.exe in Command textbox
6. Choose whatever command line you wish, and add -mono_debug
7. Click listen, and wait for server to be started and your breakpoint hit.
8. Enjoy:
(https://i.imgur.com/wZtK5.png) (http://imgur.com/wZtK5)
More info
The project contains few scripts that mimic few scripts from Den location, this is to show briefly how writing scripts in C# looks like. For more information refer to: wiki page on our trac (http://dev.fonline2238.net/trac.wsgi/wiki/MonoScripting).
-
So what? Instead of AngelScript I can now do VB.NET or C# or C++?
-
...or F#.
And not really 'instead', rather 'additionally'.
-
F# huh? I might give it a try. This sure is good news.
-
Added info about debugging.
-
Error: Forbidden
WIKI_VIEW privileges are required to perform this operation on MonoScripting
-
You need to login with you forum credentials.
-
Very impressive and exciting. :)
Would it be technically possible to use Java the same way?
-
Apperently, there is some possibility to run Java under mono, but I wouldn't even try...why everyone asks about that Java lang. Is it any good? ;D
-
Sure, Java is the best. Well, almost... ;D
Java is platform independent and has better IDE support, maybe that's why it rules the world. ;)
But I would like to use it because I am used to it (which makes it faster to develop) and it really has better IDE support than .NET.
But thanks anyway, I found some possibility to use Java from Mono, too, I will have a look and keep you informed whether it is worth it. ;)
-
Well, but if you are talking about IDE, you would probably want to check if there is mono soft debugger plugin for it, otherwise you won't be able to debug your code in it (and I think debugging is significant part of IDE functionality).
-
Code completion, refactoring and debugging, for sure. Thanks, I'll have a look.
-
Oh this sort of Debugging method would have been very helpful a long time ago. Still, Notepad++ has grown on me..
-
I cant get it working .After " Initializing mono" it crashes.
[00:038] FOnline server, version 0504-EB.
[01:621] *** Starting initialization ****
[01:630] Initializing mono...I tried it on newest downloaded sdk. I did it like you said in first post.
I replaced .exe and .pdb files
I added in .cfg:
MonoEnabled=1
MonoLibDir=mono/liband i built solution file (with some warnings) in visual studio 2012
additionally i had to copy from mono dir file mono-2.0.dll otherwise server wont start
Can you tell me what i'm doing wrong?
I can give you dumps if needed.
(windows 7 x64)
-
I think there is problem with latest mono-2.0.dll, could you try with one from rev383?
-
you mean that one from "\fonline_sdk\Server\mono" ?
I'm using exacly that one.
edit:
I didnt saw that im using 385 rev.
like you said .I downloaded earlier version of that file and it is working now , big thanks to You :)
-
Are there any performance drawbacks when using C# for development?
-
Unless there are some unintended memory leaks, then performance should be even better, as AngelScript (as it stands now) is not yet JITted (http://en.wikipedia.org/wiki/Just-in-time_compilation), and the bytecode is interpreted as it goes.
-
That's nice to hear, thanks. :)
-
Do you plan to update FOnlineServer.exe to be compatible with the latest revision? Current version of mono server is 0504-EB, but the newest revision server has version 0518-F7.
EDIT:
Actually, currently I cannot even start the server as it crashes right after Start (and I also tried 383 revision of mono-2.0.dll).
My bad, I forgot to build the project. I "only" have compilation errors because of incompatibility.
And some additional questions:
1. Is it possible to create linux runnable of mono FOnlineServer and use it?
2. Would it be possible to implement also PlaneBegin, PlaneRun and PlaneEnd CRITTER_EVENTS? I understand that it is needed to do some work on engine to call them otherwise I would implement them by myself.
-
Do you plan to update FOnlineServer.exe to be compatible with the latest revision? Current version of mono server is 0504-EB, but the newest revision server has version 0518-F7.
Probably not that fast, so I can't promise anything. Ideally, the source would be open for you to modify, but it's not the case:)
EDIT:
Actually, currently I cannot even start the server as it crashes right after Start (and I also tried 383 revision of mono-2.0.dll).
My bad, I forgot to build the project. I "only" have compilation errors because of incompatibility.
And some additional questions:
1. Is it possible to create linux runnable of mono FOnlineServer and use it?
Should be possible.
2. Would it be possible to implement also PlaneBegin, PlaneRun and PlaneEnd CRITTER_EVENTS? I understand that it is needed to do some work on engine to call them otherwise I would implement them by myself.
You are right, and unfortunately I can't promise it's gonna be implemented in near future:(
-
Do you plan to update FOnlineServer.exe to be compatible with the latest revision? Current version of mono server is 0504-EB, but the newest revision server has version 0518-F7.
Probably not that fast, so I can't promise anything.
Thanks for the change in the newest revision. :)
-
Probably not that fast, so I can't promise anything.
Thanks for the change in the newest revision. :)
No problem, hopefuly I will be able to react faster in the future.
Anyway, can I ask what are you using it for, how it goes etc etc?
-
No problem, hopefuly I will be able to react faster in the future.
Anyway, can I ask what are you using it for, how it goes etc etc?
I was trying to remake Critter Action DSL (see the example below), which I have done in AngelScript and I wanted to rework it in C# as it is easier to debug and develop with (and also maybe have some performance improvement). But currently I am stuck, because I need also PlaneBegin, PlaneRun and PlaneEnd CRITTER_EVENTS to be implemented in Mono, so currently I am trying to remake it in pure C++. ;D
But nevertheless I plan to develop new features in C# (for the productivity), but I am not very productive on the project, so not having much progress ATM. :)
Critter Action DSL: (I know it is not really a DSL, but just to explain what I mean)
This is meant to be used as a simple language to make it easy to setup roles (actions) for NPCs. See the following example and keep in mind, that it is planed to make it public, when it is in the state of publishing. ;D
Examples: :)
Johny, the hungry kid will try to find a (closest) player and asks him for food. Then he searches if any food is on the ground and picks it up:
void _HungryKidInit(Critter& npc, bool firstTime)
{
#define TO_DISTANCE (3)
Action@ action = LoopAction()
.AddSubAction(FindCritters(ClosestPlayer)
.If(IsSeen())
.AddSubAction(LoopAction(2)
.AddSubAction(Follow(TO_DISTANCE))
.AddSubAction(LookAt())
.AddSubAction(Say(TEXTMSG_TEXT, 70113))
.AddSubAction(Wait(REAL_SECOND(5)))))
.AddSubAction(FindItems(FOOD_ITEMS)
.AddSubAction(PickUp())
.AddSubAction(DeleteItems()))
.AddSubAction(Patrol(DEFAULT_PATROL_ENTIRE, true))
.AddSubAction(Wait(REAL_SECOND(3)))
;
actionManager.Start(npc, action);
}
Brahmin wondering around:
void _InitBrahmin(Critter& npc, bool firstTime)
{
Action@ action = LoopAction(true)
.AddSubAction(AttackAttacker())
.AddSubAction(ChangeDirection(RANDOM_DIRECTION, true))
.AddSubAction(Wait(REAL_SECOND(5), REAL_SECOND(30)))
;
actionManager.Start(npc, action);
}
-
Nice, it reminds me of behavior trees (http://www.altdevblogaday.com/2011/02/24/introduction-to-behavior-trees)
-
Nice, it reminds me of behavior trees (http://www.altdevblogaday.com/2011/02/24/introduction-to-behavior-trees)
Thanks, finally I know how to name the framework. ;D
It is, indeed, something that is supposed to be very close to it (even if I have never heard of it before). Good to know something like that exists and I can use it as a knowledge base. ;)
-
There used to be tons of info about in on AiGameDev.net
-
First of all, thanks for those missing critter events in the newest revision. :)
Second of all I have a question for you:
Is it possible to define interface in Mono and make an implementation of that interface in AngelScript, so it can be further passed to Mono code for processing?
-
At the moment, you could try something like:
C# interface:
interface IFoo {
void Bar();
}
Then, in AngelScript (let's say it's module foo):
class FooImpl { // not that it doesn't say anywhere we implement that interface
void Bar() { ... }
}
FooImpl GetImplementation() { return FooImpl(); }
Back in C#:
class FooImplWrapper : IFoo {
ScriptObject foo;
public Wrapper(ScriptObject impl) {
foo = impl;
}
public void Bar() {
foo.Bar(); // dynamic call
}
}
dynamic module = AngelScript.GetModule("foo");
var foo = new FooImplWrapper(module.GetImplementation());
foo.Bar();
But it's rather ugly, and it's exploiting AS dynamic wrappers which are rather experimental (and do not work with overloaded functions).
I never planned such tight binding (implementing interfaces across different script runtime boundaries), as it bounds to be pretty complicated, so question is, what kind of design decisions led you to such requirement?
-
I never planned such tight binding (implementing interfaces across different script runtime boundaries), as it bounds to be pretty complicated, so question is, what kind of design decisions led you to such requirement?
It is again those Critter Action Behaviour Trees I am working on. I already have system that manages these actions (let's call it Manager) and set of actions in AngelScripts.
What I am thinking is reimplementing Manager in Mono, but to be able to reuse those existing actions by introducing interface in Mono, which existing actions would implement, so I could reuse those actions in Manager in Mono.
The second reason is not to be bound to Mono code, as maybe someone does not want to use it in their project and he can implement actions in AngelScript.
And the third reason is the ability to easily switch between the AngelScript Manager and Mono Manager to e.g. see the difference in performance or just to have fallback Manager in case that your Mono project won't be maintained anymore (not compatible with the newest revision of SDK as it happened after UTF change or you will discontinue the project).
I was trying something like that in C++, so I introduced interface which is then implemented in AngelScript (already existing actions), and create C++ Manager for the actions, but I am struggling with it a bit as I am not advanced user of C++ (as being Java focused), but that's another story :)
-
How does this interface look like? Maybe by looking at methods signatures I could think of something/have better knowledge about those requirements.
-
This is the current interface of Action in AngelScript (but it is not in its final state):
interface Action
{
Action@ GetSuperAction();
void SetSuperAction(Action@ action);
Action@ AddSubAction(Action@ action);
Action@[] GetSubActions();
void CollectListeningActions(Action@[]& collection);
Action@ And(Action@ andAction);
Action@ If(Condition@ condition);
Action@ IfNot(Condition@ condition);
void PerformAndAction(Critter& critter, Critter@ otherCritter, Item@ item);
bool Check(Critter& critter, Critter@ otherCritter, Item@ item);
bool IsRunning();
void SetRunning(bool running);
bool IsListening();
void SetListening(bool listening);
bool Start(Critter& critter);
void Perform(Critter& critter);
void Finish(Critter& critter);
void Cancel(Critter& critter);
void StartNextAction(Critter& critter);
string GetInfo();
void IdleEvent(Critter& critter);
void ShowCritterEvent(Critter& critter, Critter& showCritter);
void HideCritterEvent(Critter& critter, Critter& hideCritter);
bool AttackEvent(Critter& critter, Critter& target);
bool AttackedEvent(Critter& critter, Critter& attacker);
void DeadEvent(Critter& critter, Critter@ killer);
void MessageEvent(Critter& critter, Critter& messenger, int message, int value);
void SeeSomeoneAttackEvent(Critter& critter, Critter& attacker, Critter& attacked);
void SeeSomeoneDeadEvent(Critter& critter, Critter& killed, Critter@ killer);
void SeeSomeoneAttackedEvent(Critter& critter, Critter& attacked, Critter& attacker);
void SeeSomeoneStealingEvent(Critter& critter, Critter& victim, Critter& thief, bool success, Item& item, uint count);
void SeeSomeoneUseSkill(Critter& critter, Critter& skillCritter, int skill, Critter@ onCritter, Item@ onItem, Scenery@ onScenery);
int PlaneBeginEvent(Critter& critter, NpcPlane& plane, int reason, Critter@ someCr, Item@ someItem);
int PlaneRunEvent(Critter& critter, NpcPlane& plane, int reason, uint& result0, uint& result1, uint& result2);
int PlaneEndEvent(Critter& critter, NpcPlane& plane, int reason, Critter@ someCr, Item@ someItem);
}
And Manager has void Start(Critter& critter, Action& action) function, which starts the action for specified critter.
-
I am scared to ask, but what "Virtual events did nothing good" (https://xp-dev.com/sc/change/76003/408) means?
-
It means I've screwed commit message (commiting from git to svn is tricky).
This commit also involved some project structure refactoring, and it should be described in message instead). Scrapping virtual modifier from events was just minor part of refactor.
-
I have problem running Mono server after the latest changes. I tried it on clean version of SDK, rebuild the Mono solution in MonoDevelop, but executing FOnlineServer.exe and pressing Start server will crash the server without dump file created, so I am not sure why it is happening. Did I forget to do something or there might be a bug introduced?
-
I think I know, and it wasn't explained in commit message because I screwed it (as you already know).
The project is now refactored into core FOnline.Mono.dll and FOnline.Server.exe which is the entry assembly for server. Your FOnlineServer.cfg should have the
MonoAssembly=FOnline.Server.exe
line.
-
I think I know, and it wasn't explained in commit message because I screwed it (as you already know).
The project is now refactored into core FOnline.Mono.dll and FOnline.Server.exe which is the entry assembly for server. Your FOnlineServer.cfg should have the
MonoAssembly=FOnline.Server.exe
line.
Should I wait for fixed revision or MonoAssembly=FOnline.Server.exe should be enough to fix it?
-
Should I wait for fixed revision or MonoAssembly=FOnline.Server.exe should be enough to fix it?
Should be enough
-
Should be enough
Didn't help. :(
But the problem seems to be that FOnline.Server.exe is not built in Server directory (or anywhere else) after rebuilding the project (I am trying to rebuild Server using Debug|x86). Any suggestions?
EDIT:
Nevermind, I missed incorrect Output path of Assembly set for FOnline.Server project. :)
-
When I run mono server, NPC dialogs are not working at all (invoking via scripts or clicking on NPC). Do you know about the problem?
Note: I have tested it also on vanilla SDK.
BTW: Do you have any issue tracker where I could entry such issues?
-
BTW: Do you have any issue tracker where I could entry such issues?
https://bitbucket.org/rotators/fosrc/issues
-
https://bitbucket.org/rotators/fosrc/issues
It is only for issues with mono or for all bugs related to fonline sdk?
-
- Is it safe to create Timer (and use it for managing e.g. controlling Critter's actions)?
- I am getting Script::GetGlobalContext - Script context stack overflow! Context call stack: (no call stack after). Is this message part of Mono server? Could it be caused by having another (Timer) thread?
-
It is only for issues with mono or for all bugs related to fonline sdk?
For now it's a place for mono-related things, but it would definitely be only for engine-related issues.
Any particular thing you've had in mind?
- Is it safe to create Timer (and use it for managing e.g. controlling Critter's actions)?
- I am getting Script::GetGlobalContext - Script context stack overflow! Context call stack: (no call stack after). Is this message part of Mono server? Could it be caused by having another (Timer) thread?
- It's better to stay away from multithreading. The Critter (and other game objects) methods are not thread safe. You could use another thread timer with some thread-safe collection that would then act as message dispatcher (and messages it will got could be handled in main loop). And I think that normal Game Events are still viable option (after all, they are saved).
- Can I have some code snippet?
-
- It's better to stay away from multithreading. The Critter (and other game objects) methods are not thread safe. You could use another thread timer with some thread-safe collection that would then act as message dispatcher (and messages it will got could be handled in main loop). And I think that normal Game Events are still viable option (after all, they are saved).
- Can I have some code snippet?
- I wanted to have independent thread not to affect performance (it is for Behavior Trees :) ). But it is easier for me to just use Game events for now, which seem that work fine. I will do some load tests to see if the performance is not an issue.
- Hm, it looks like doing it in another thread was causing the exception. It is hard to provide some code snippet, but if you want you can check mono_bt branch (https://github.com/wladimiiir/vault112/tree/mono_bt), where I am doing these changes.
-
Might I ask, does 2238 SDK support mono or not? Also, I do not understand the advantages by using mono.
-
As of rev409, mono subdirectory has been removed from sdk/Server, and its development moved to: https://github.com/rotators/fomono
The repository contains only source files, the rest (modified engine executables + mono libs) are included in releases (https://github.com/rotators/fomono/releases).
This is not only a part of moving our development endeavours in the open source wilderness, it should also make it easier for people wanting to use this modification - as it is now, the library source is the same as the files you need to alter for your particular application (Critter/Item/Map classes etc). Having those files separated as git repository can help with source management.
Might I ask, does 2238 SDK support mono or not? Also, I do not understand the advantages by using mono.
The mono integration hadn't been used with 2238, but you could easily set it up (using aforementioned repository). The only drawback would be that you will be using different server engine executable (you need to overwrite 2238' one with the one from fomono release) - if you're interested in details, ask.
As for advantages, well, just check the first post of this thread.
-
I have some questions about entry functions:
1. When I have entry function for initialization of critter in C#, am I supposed to use explicit conversion:
public static Critter InitCritter (IntPtr ptr, bool firstTime)
{
Critter npc = (Critter) ptr;
...or contructor
public static Critter InitCritter (IntPtr ptr, bool firstTime)
{
Critter npc = new Critter(ptr);
...Both seems to be working fine, but what is the difference here?
2. I would like to implement custom check_look function in C#, but I am not able to bind the function in scripts.cfg. Is it somehow possible or not really without some additional support in hardcoded part of Mono extension?
Thank you. :)
-
1. Explicit conversion from IntPtr.Zero will return null reference, whereas new Critter(IntPtr.Zero) will create invalid wrapper pointing to IntPtr.Zero and possibly soon crashing the whole serv. But in init functions it's not possible for the pointer to be zero, so there is no difference here.
2. The scripts.cfg bindings are not working, because scripts.cfg won't allow you to define declaration, and take hardcoded one. And hardcoded ones are AS declarations, not mono ones, difference is:
// AS
viod funcname(int, int)
// mono
void Namespace.ClassName::Method(int,int)
so in mapper/dialog you may specify script as mono@SomeClass::Foo and have it working, but you can't do the same in scripts.cfg...
Of course you can do dirty:
// scripts.cfg
check_look some_module
// some_module
#pragma bindfunc "bool Helper(Critter&, Critter&) -> mono CheckLook::Check" // don't remember exact signature
bool check_look(Critter& cr1, Critter& cr2)
{
return Helper(cr1,cr2);
}
// mono class
class CheckLook
{
public bool static Check(IntPtr ptr1, IntPtr ptr2)
{
var cr1 = (Critter)ptr1;
var cr2 = (Critter)ptr2;
// ...
}
}
-
1. Did you think about having implicit operator (instead of explicit) for Critter?
public static implicit operator Critter(IntPtr ptr)So in initialization function you could just write:
public static Critter InitCritter (IntPtr ptr, bool firstTime)
{
Critter npc = ptr;
...
2. So if I understood it, without introducing some additional functions in FOnline.Main class, the only workaround how I could use it is to bind managed function
#pragma bindfunc "void Foo() -> mono Classname::MethodName"and call it in main.fos@check_look?
But I suppose this is stupid solution, right? :)
-
1. I kinda don't like implicit conversions, would be damn useful if they would be used when engine calls mono method, but they don't (hence engine-callble methods take IntPtr as argument).
2. Yeah, kind of dirty, but should work.