The Mugen Fighters Guild

M.U.G.E.N Central => MFG Presents Street Fighter => FullGame development => Ryu => Topic started by: Just No Point on June 20, 2014, 09:25:19 pm

Title: Documenting and updating our template
Post by: Just No Point on June 20, 2014, 09:25:19 pm

I'd like to discuss what the best way to document Ryu for new creators and old alike would be.

Here is an example:

Spoiler, click to toggle visibilty

Code:

; S.Lp
[Statedef 200]
type    = S                      
movetype= A                      
physics = S                      
juggle = 1                      
velset = 0,0                     
ctrl = 0                         
anim = 200                       
poweradd = 10                    
sprpriority = 2
faceP2 = 1                  

[State 200, snd]
type = PlaySnd
trigger1 = AnimElem = 1
value = S1, 1

    [State 200, Time Offset]
    type = VarSet
    trigger1 = moveContact = 1
    var(2) = Time
    ignorehitpause = 1
    persistent = 0

    [State 200, Play Anim]
    type = ChangeAnim
    triggerall = AnimElemTime(2) >= 0 && AnimElemTime(3) <= 0
    trigger1 = hitPauseTime = [1,7 - (3 - Var(2))]
    value = anim
    elem = 3
    ignorehitpause = 1

[State 200, hit]
type = HitDef
trigger1 = AnimElem = 2
attr = S, NA
damage = ceil(ifelse(fvar(11) * 21 < 7, 7, fvar(11) * 21)),0
animtype = Light
air.animtype = back
fall.animtype = back
guardflag = M
hitflag = MAF
air.animtype = back   
pausetime = 7,8
sparkno = 0
sparkxy = -10, -82
hitsound = S2, 1
guardsound = S2, 0
ground.type = High
ground.slidetime = 10
ground.hittime  = 12
ground.velocity = -5.50 
guard.slidetime = 11
guard.hittime = 11
guard.velocity = -5
airguard.velocity = -5, 0
air.type = High
air.velocity = -3,-6
ground.cornerpush.veloff = 0
air.cornerpush.veloff = 0

[State 200, Idle]
type= statetypeset
trigger1= animelemtime(4)>=0
movetype= I

[State 200, end]
type = ChangeState
trigger1 = !AnimTime
value = 0
ctrl = 1

This is a simple Standing Light Punch

I am curious if each part of the code should be documented to explain what it does or means. As far as assuming people are familiar with the source of course. If you have never played a SF game we will not be discussing the parts that deeply!
Perhaps the coding should only be documented in a dedicated documentation thread to add links like this:
You will find this part in ryu.command

• [Command]   
• name = "x"     Name of the command. Could be changed to "Light Punch" or something but in this instance it'll stay "X"
• command = x  Says that pressing x initiates the command
• time = 1    You have 1 tick to complete this command

You will find the following lower down the ryu.command file under the [Statedef -1] area

• ;Stand Light Punch
  anything after ";" is not read in MUGEN
• [State -1, Stand Light Punch] 
  name of state
• type = ChangeState (http://elecbyte.com/wiki/index.php/ChangeState) 
  you are changing the state of the character
• value = IfElse (http://elecbyte.com/wiki/index.php/IfElse)(P2BodyDist (http://elecbyte.com/wiki/index.php/P2BodyDist) X > (http://elecbyte.com/wiki/index.php/Expressions) 12,200,205)
  Ryu has a near LP and a far LP, had he only had 1 LP you would have merely put value = 200
  IfElse means MUGEN will choose one, or the other depending on the following criteria
  P2BodyDist tells how far away the character is to Ryu. In this case if Ryu is greater than 12 pixels away from the opponent then hitting "x" initiates state 200, if less than 13 pixels away Ryu will initiate state 205 which is his Close Range Standing LP attack, the elbow
• trigger (http://elecbyte.com/wiki/index.php/CNS#id29)all = command = "x" && command != "holddown" && statetype (http://elecbyte.com/wiki/index.php/StateType) != a
  This triggers when the following all occur (are true)
  command = "name of move given earlier "x""
  && means "and" this means all these these listed must be true at the same time
  command != "holddown" does not work while holding down, which is the name of the command holding down (duh)
  &&  statetype  != A     means it cannot be done in the air
• trigger1 = ctrl
  You must always have at least one trigger 1, you do NOT have to have triggerall, this means the move can only trigger if all the triggerall parameters are true and you also have control of your character

The following is found in basics.st

• [Statedef 200] (http://elecbyte.com/wiki/index.php/CNS#id12)
    This is the default state number for a Standing Light Punch in MFG p SF
• type (http://elecbyte.com/wiki/index.php/CNS#id14)    = S                       
  Stand     
• movetype (http://elecbyte.com/wiki/index.php/CNS#id15) = A                 
  Attack   
• physics  (http://elecbyte.com/wiki/index.php/CNS#id16)= S                     
  Standing
• juggle (http://elecbyte.com/wiki/index.php/CNS#id21) = 1                       
  I think this will be removed anyway as I'll have to code in a custom juggle system
• velset (http://elecbyte.com/wiki/index.php/VelSet) = 0,0                    
  No velocity is set in either [x,y] directions
• ctrl (http://elecbyte.com/wiki/index.php/CNS#id19) = 0                           
  0 means does not have control
• anim  (http://elecbyte.com/wiki/index.php/CNS#id17)= 200                    
  directs to animation 200 in the air
• poweradd (http://elecbyte.com/wiki/index.php/CNS#id20)= 10               
   How much power is given from using the attack *note to self, I need to change these for Ryu for if he hits or misses
• sprpriority (http://elecbyte.com/wiki/index.php/CNS#id26) = 2               
  Makes the sprites appear in front of priority 1(jumping) and 0(standing/crouching) sprites
• faceP2 (http://elecbyte.com/wiki/index.php/CNS#id22) = 1                      
  1 makes the character face the opponent during this attack

I'm kind of thinking this would be the better way to approach this. Perhaps saving what I post on the forum as html as well so that I can add it to Ryu in a documentation folder. The old Mugen Code tag would be great right about now!

Comments? Suggestions?

Title: Re: Documenting and updating our template
Post by: XGargoyle on June 22, 2014, 11:20:26 am

You are basically posting the content of Elecbyte's docs there... is it worth documenting every line?

I would document only the necessary parts, as in the specifics of the full game environment, but documenting that a semicolon is used to comment something out I find it ridiculous and a real waste of time/efforts

just my 2 cents

Title: Re: Documenting and updating our template
Post by: Just No Point on June 22, 2014, 01:40:53 pm

Semi colon thing is over doing it, yes. I just wanted something for each line of code :P

Keep in mind I'm hoping that this helps people that have never tried to code before participate. Some of this stuff I even missed when I was looking for more info on it because info is strung across all kinds of pages of DOCs. It is also a way for me to keep pushing this stuff in my own head. Because I'm rereading everything I'm linking to as well.

Anyway, it's not like I'm going to do this with every line of code. I'm thinking to do this with the rest of the LP code. And a few snippets of code from some other basics that get different lines of code added.

I might want to separate the documentation into the file names found in Ryu; IE Basics.st, ryu.command, constants.cns, etc and make a sticky post that harbors links to each part. Also giving a list on the standards being used in the sticky.

@Loona: You're just as ridiculous about this stuff as I am. You have any input?

Title: Re: Documenting and updating our template
Post by: Loona on July 11, 2014, 01:47:12 am

All that comes to mind right now is don't repeat comments in the same file - it's OK to be detailed early on, but after that just comment what's different from what was already commented.

Title: Re: Documenting and updating our template
Post by: Just No Point on July 11, 2014, 02:09:15 am

That's the plan.

This slowed down because there is a ton of stuff being added to the basic setup for all moves due to coding the config file. I should stick with my guns and wait till he's more complete to document.

Another thing I intend to do will be make a quick view on standards in the coding. For people familiar with coding it will explain what must be kept in what situations. Like the universal hitpauses I found for certain attacks, JZ's coding that is used to make the hit pause pause on a later frame than the one that connects, etc