Re-structure the project tree about minecraft

[embatbr]

Reading this blog: http://as.ynchrono.us/2007/12/filesystem-structure-of-python-project_21.html

This project structure comes out:

Project/
|-- bin/
| |-- project
|
|-- project/
| |-- test/
| | |-- init.py
| | |-- test_main.py
| |
| |-- init.py
| |-- main.py
|
|-- setup.py
|-- README

[embatbr]

So, no one?

[embatbr]

Guys, would you bother if I rearrange the project tree? I want to change ideas of implementation and insert some documentation.

[joshuaskelly]

Fork it and go to town!

[embatbr]

You mean a real fork or a github fork (that I alredy did)?

[jminardi]

From the README:

I would like to see this project turn into an educational tool. Kids love Minecraft and Python is a great first language. This is a good opportunity to get children excited about programming.

So the goal of this project is to get kids excited about programming, not to have production level project organization. I think the changes your propose would make it easier for professional python programmers to install this package, but tougher for kids to grasp what is going on. For that reason I do not think the hierarchy should be changed.

[embatbr]

I see.

[BertrandBordage]

So the whole project will stay in one file? Since we want it to be well documented, this will become a huge file…

[jminardi]

I already went through and documented every method and attribute. The file is still under 1000 lines.

[embatbr]

jminardi, but are you talking about formal documentation or that Python inside-the-code documentation using docstring? Because the code I merged 3 hours ago just have some comments.

Bertrand, I wanted to do this way:

NameOfProject
NameOfProject/bin/
NameOfProject/lib/
NameOfProject/docs/
NameOfProject/tests/
NameOfProject/NameOfProject/
NameOfProject/NameOfProject/logic/
NameOfProject/NameOfProject/logic/entities.py
NameOfProject/NameOfProject/logic/physics.py
NameOfProject/NameOfProject/presentation/
NameOfProject/NameOfProject/presentation/graphics.py
NameOfProject/NameOfProject/presentation/keyboard.py
NameOfProject/NameOfProject/presentation/mouse.py

and so on.

To me it's not that complicated. And is even better for begginners to understand.

[jminardi]

@embatbr I am talking about this recently merge PR: #35

I disagree however that your nested directory structure would be easier to beginners for understand.

[embatbr]

jminardi, and what about things like the definition of class Player be in the main.py? I guess it isn't helpful to teach. Because Player inherit from Entity, that is in another separated module (with only it's definition). The entity module looks more like a class file in Java.

[jminardi]

I am not sure what you are referring to when you say Player and Entity. In master there are only two classes: Model and Window

[BertrandBordage]

@embatbr Totally agree, all the beginners to whom I taught programming were discouraged when facing huge files. And these times are gone.

I don't know however if double "NameOfProject" is a good idea. This is useful in Django projects to override templates, but it should be avoided here.
I also dislike "bin", "lib", "logic", and "presentation". "bin" and lib are useless (no real binary and libs are installed via pip). "logic" and "presentation" should be more generic and revelant, like "engine" and "settings".

@jminardi 1000 lines isn't small, and this is just the beginning.

[embatbr]

Yeah, it's because I still don't think totally as a Python programmer. I learned to program with Java, back in 2005, and for many years used the "Java way of programming" even writing pure C code. As Python doesn't require a "file per class" as Java or .h files, we can make something more simple.

But still is good to make a "source" package, to separate from tests, doc and etc. I suggested have the same name of the root because I see it a lot in Python projects and is good to make a distribuition (just get a package named "game name") of the game itself. Also, for the other porpouse, the educational tool, the students can get the entirely project folder.

So, I suggest we at least separate the game code in a proper folder. And take the logic definition from main.py.

[embatbr]

jminardi, it's because fogleman's repository is old. I forked from boskee's repository, that has a lot of code. Check it out: https://github.com/boskee/Minecraft

[EDIT] many other people use boskee's repository as base, so if you clone his repository, you will see a limited world, with day and night and the simple inventory.

[BertrandBordage]

Wooo, @boskee worked a lot!

[embatbr]

I still don't know why fogleman didn't merged.

[embatbr]

boskee's tree is the unofficial new master tree. =p

Another suggestion: use to branches. One for a stable version and another for development.

[embatbr]

I forked the project into another repository and I am replacing things rewriting code.
Now I am learning how to use the pyglet.

https://github.com/embatbr/Dollycraft

[fogleman]

Suggested tree is too complex.