Streamline development effort : Backlog capture and planning

An area for discussing new ideas and additions to Oolite.

Moderators: another_commander, winston

User avatar
hiran
Theorethicist
Posts: 2656
Joined: Fri Mar 26, 2021 1:39 pm
Location: a parallel world I created for myself. Some call it a singularity...

Re: Streamline development effort : Backlog capture and planning

Post by hiran »

mcarans wrote: Wed Apr 01, 2026 5:26 am
The idea of the backlog is, I hope, that other people will both add to it and implement things on it otherwise it is no more than my plan and my implementation of that plan.
Another use for the backlog is that we disuss and agree on changes as a group which allows getting involved and be part of the lot. The last couple of changes were announced after having been applied to the master branch. This does not feel collaborative. It even gives the impression that further contributions are unwanted.

Thank you for opening the discussion.
Sunshine - Moonlight - Good Times - Oolite
User avatar
mcarans
---- E L I T E ----
---- E L I T E ----
Posts: 790
Joined: Sun Jun 20, 2010 6:00 pm

Re: Streamline development effort : Backlog capture and planning

Post by mcarans »

hiran wrote: Wed Apr 01, 2026 10:23 am
I was thinking about removing the dependency to LibreOffice. I'm not stuck with that.

But it is still important in my eyes to know which documentation relates to wich Oolite version. Thus I'd like to see a version stamp on it.

The PDFs we used to have in the repository were updated rarely. Yet when they were devs forgot to update version numbers or other metadata or were simply unable to generate the PDFs using the correct fonts and layout.

So I moved PDF generation into Github, although that introduced the dependency on LibrOffice.

I am wondering now how you would cover a build without LibrOffice and without going back to having the PDF generation on the developer's table.
That is actually what we have at the moment. The pdfs are currently being built in readthedocs and are downloaded from there during the Windows build. The pdfs are irrelevant to the MS Store and all Linux builds because they are not traditional installers, hence the readthedocs site. Personally I'd be in favour of the documentation being made available from a menu in the game itself. All the other approaches seem like kludges to avoid having to write Obj-C code to handle it.
User avatar
hiran
Theorethicist
Posts: 2656
Joined: Fri Mar 26, 2021 1:39 pm
Location: a parallel world I created for myself. Some call it a singularity...

Re: Streamline development effort : Backlog capture and planning

Post by hiran »

Sounds like we traded the dependency on LibreOffice for a dependency on readthedocs.

Indeed it sounds steange to download these PDFs back from readthedocs.

But you mention the PDFs are not required for the modern builds. Actually there is no common pattern where to provide documentation for modern software. Should we embed PDF and PDF readers into Oolite? Should we add HTML documentation and a web browser?

What would happen if we packaged the appimage into an installer that creates directories, creates desktop icons and links to the PDF documentation?
Sunshine - Moonlight - Good Times - Oolite
User avatar
mcarans
---- E L I T E ----
---- E L I T E ----
Posts: 790
Joined: Sun Jun 20, 2010 6:00 pm

Re: Streamline development effort : Backlog capture and planning

Post by mcarans »

hiran wrote: Wed Apr 01, 2026 9:38 pm
Sounds like we traded the dependency on LibreOffice for a dependency on readthedocs.

Indeed it sounds steange to download these PDFs back from readthedocs.

But you mention the PDFs are not required for the modern builds. Actually there is no common pattern where to provide documentation for modern software. Should we embed PDF and PDF readers into Oolite? Should we add HTML documentation and a web browser?

What would happen if we packaged the appimage into an installer that creates directories, creates desktop icons and links to the PDF documentation?
I think packaging an appimage in an installer defeats the simplicity of appimage.

AI claims that you can display a PDF in GNUstep like this:

Code: Select all

#import <PopplerKit/PopplerKit.h>

// In your Controller
- (void)showManual {
    // PDFDocument and PDFView here map very closely to Apple's syntax
    PDFDocument *doc = [[PDFDocument alloc] initWithURL: [NSURL fileURLWithPath: @"/app/share/doc/manual.pdf"]];
    
    PDFView *view = [[PDFView alloc] initWithFrame: [myWindow contentRect]];
    [view setDocument: doc];
    [[myWindow contentView] addSubview: view];
}
PopplerKit is apparently the GNUstep equivalent to Apple's PDFKit. Assuming it is simple like that, then I think this would be the best way to have documentation accessible for all Windows and Linux versions within the game download.
User avatar
hiran
Theorethicist
Posts: 2656
Joined: Fri Mar 26, 2021 1:39 pm
Location: a parallel world I created for myself. Some call it a singularity...

Re: Streamline development effort : Backlog capture and planning

Post by hiran »

Then let's try PopplerKit.

While we are discussing the backlog here are two items I thought about:

- revive some unit testing framework
Allow Oolite to be automatically tested on every build. This allows to start modifying the code and ensure it does not break.

- maybe with the help of AI translate ObjC code to C++
As the Mac is no longer the main platform, changing the project language bit by bit will allow more people and better development tools to be used.

These two points are huge but would remove the showstopper of an untouchable core or the need for developers to learn a niche language.
Sunshine - Moonlight - Good Times - Oolite
User avatar
Lone_Wolf
---- E L I T E ----
---- E L I T E ----
Posts: 838
Joined: Wed Aug 08, 2007 10:59 pm
Location: Netherlands

Re: Streamline development effort : Backlog capture and planning

Post by Lone_Wolf »

I like the backlog idea and think it will help a lot to see/discuss where oolite will stand in the future.

Poppler is a well known library for dealing with pdfs and used by many popular applications like Okular, GIMP, Evince, calibre, Libreoffice . It also seems to be available for windows .

It has a GPL license so can only be used by applications with compatible licenses. Since oolite is GPL 2 or later oolite is compatible.

I think poppler is as close to a standard for dealing with pdfs as one can get and a good choice for an oolite dependency
OS : Arch Linux 64-bit - rolling release

From: The Netherlands, Europe

OXPs : My user page (needs updating)

Retired, occasionally active
User avatar
hiran
Theorethicist
Posts: 2656
Joined: Fri Mar 26, 2021 1:39 pm
Location: a parallel world I created for myself. Some call it a singularity...

Re: Streamline development effort : Backlog capture and planning

Post by hiran »

Lone_Wolf wrote: Thu Apr 02, 2026 8:28 am
I like the backlog idea and think it will help a lot to see/discuss where oolite will stand in the future.
That makes it three of us.

Actually we can start right now logging the ideas on Github and discuss feature per feature in the respective issues.

To better organize issues we would want to experiment with projects. Who can unlock this feature on Github?
Sunshine - Moonlight - Good Times - Oolite
User avatar
phkb
Impressively Grand Sub-Admiral
Impressively Grand Sub-Admiral
Posts: 5699
Joined: Tue Jan 21, 2014 10:37 pm
Location: Writing more OXPs, because the world needs more OXPs.

Re: Streamline development effort : Backlog capture and planning

Post by phkb »

hiran wrote: Thu Apr 02, 2026 10:41 am
Who can unlock this feature on Github?
Well, I can create a project. There are a bunch of templates (Team Planning, KanBan, Bug Tracker, Feature Release, Iterative Development, Product Launch, Roadmap and Team Retrospective). What ones do you want to experiment with?
User avatar
hiran
Theorethicist
Posts: 2656
Joined: Fri Mar 26, 2021 1:39 pm
Location: a parallel world I created for myself. Some call it a singularity...

Re: Streamline development effort : Backlog capture and planning

Post by hiran »

phkb wrote: Thu Apr 02, 2026 2:46 pm
hiran wrote: Thu Apr 02, 2026 10:41 am
Who can unlock this feature on Github?
Well, I can create a project. There are a bunch of templates (Team Planning, KanBan, Bug Tracker, Feature Release, Iterative Development, Product Launch, Roadmap and Team Retrospective). What ones do you want to experiment with?
Is it either or? As I do not yet know where we are going let's get started on something.
I suggested we could collect ideas and discuss then which might end up in a roadmap.

Later - if things work out - we might more head towards iterative development and kanban boards or all of them.
Sunshine - Moonlight - Good Times - Oolite
User avatar
phkb
Impressively Grand Sub-Admiral
Impressively Grand Sub-Admiral
Posts: 5699
Joined: Tue Jan 21, 2014 10:37 pm
Location: Writing more OXPs, because the world needs more OXPs.

Re: Streamline development effort : Backlog capture and planning

Post by phkb »

Ok, "Project: Roadmap" is up. Let me know if you can't see it.
User avatar
hiran
Theorethicist
Posts: 2656
Joined: Fri Mar 26, 2021 1:39 pm
Location: a parallel world I created for myself. Some call it a singularity...

Re: Streamline development effort : Backlog capture and planning

Post by hiran »

phkb wrote: Thu Apr 02, 2026 9:40 pm
Ok, "Project: Roadmap" is up. Let me know if you can't see it.
I can see it. Thank you for that.
So now we can experiment how to organize the issues into the different views. There is Backlog, Quarterly and Monthly already.

@all: Add your ideas as issues. We can then discuss them and once aligned open them for implementation.

edit: I just logged
https://github.com/OoliteProject/oolite/issues/568
https://github.com/OoliteProject/oolite/issues/569
and added them to the project.

Who else can see it?
Sunshine - Moonlight - Good Times - Oolite
User avatar
mcarans
---- E L I T E ----
---- E L I T E ----
Posts: 790
Joined: Sun Jun 20, 2010 6:00 pm

Re: Streamline development effort : Backlog capture and planning

Post by mcarans »

hiran wrote: Thu Apr 02, 2026 9:56 pm
phkb wrote: Thu Apr 02, 2026 9:40 pm
Ok, "Project: Roadmap" is up. Let me know if you can't see it.
I can see it. Thank you for that.
So now we can experiment how to organize the issues into the different views. There is Backlog, Quarterly and Monthly already.

@all: Add your ideas as issues. We can then discuss them and once aligned open them for implementation.

edit: I just logged
https://github.com/OoliteProject/oolite/issues/568
https://github.com/OoliteProject/oolite/issues/569
and added them to the project.

Who else can see it?
I can see it. I added a whole load of issues for the backlog items I've described in this thread. I hope that this doesn't become a talking shop but encourages new devs to step forward and implement some of these ideas.
User avatar
hiran
Theorethicist
Posts: 2656
Joined: Fri Mar 26, 2021 1:39 pm
Location: a parallel world I created for myself. Some call it a singularity...

Re: Streamline development effort : Backlog capture and planning

Post by hiran »

This is great. We already have 20 issues on the backlog. The ideas are there, and more are welcome.

Yes, I also want this to be more than just talking. Now that we collect stuff we can see what to do next.
So I think we should discuss the issues, agree how to implement and then action the single issues.

As far as I can see we are four people. To have a reasonable gate I suggest at least two people to agree on an issue.
Votes could be as simple as the Apache Foundation does by writing a "+1" for approval or a "-1" for disapproval.

Also I found another potential source of community members - or the constructive critics: Our project has a few pull requests pending. If we ignore them to death the author behind will get disappointed. If we approve or at least comment on the PRs the author gets some feedback from us which enforces the bond - to us and the project. Thus I'd like to not just discuss our own ideas but also look at these open PRs. And likely we should discuss the PRs first. If we keep changing our master we have to rebase/fix the PRs as well.

Likely we will have to change or refine the way we work so the above is not carved in stone. Eventually we can document it in a wiki page so others perceive transparency.

Please comment if you agree or have concerns. :-)
Sunshine - Moonlight - Good Times - Oolite
User avatar
mcarans
---- E L I T E ----
---- E L I T E ----
Posts: 790
Joined: Sun Jun 20, 2010 6:00 pm

Re: Streamline development effort : Backlog capture and planning

Post by mcarans »

hiran wrote: Fri Apr 03, 2026 8:29 pm
This is great. We already have 20 issues on the backlog. The ideas are there, and more are welcome.

Yes, I also want this to be more than just talking. Now that we collect stuff we can see what to do next.
So I think we should discuss the issues, agree how to implement and then action the single issues.

As far as I can see we are four people. To have a reasonable gate I suggest at least two people to agree on an issue.
Votes could be as simple as the Apache Foundation does by writing a "+1" for approval or a "-1" for disapproval.

Also I found another potential source of community members - or the constructive critics: Our project has a few pull requests pending. If we ignore them to death the author behind will get disappointed. If we approve or at least comment on the PRs the author gets some feedback from us which enforces the bond - to us and the project. Thus I'd like to not just discuss our own ideas but also look at these open PRs.

We'll likely have to change or refine the way we work so the above is not carved in stone. Eventually we can document it in a wiki page so others perceive transparency.

Please comment if you agree or have concerns. :-)
I don't think it's a good idea to add old issues to the project board. It will just create a lot of noise. I think the original 20 issues are more than enough to occupy the current dev team for years to come so little point in adding things that no one will have any time to look at unless you're putting yourself forward to go through all those old PRs and test them (eg. the FOV one is from 2015 and the code has changed since then). Many projects have rules set up that autoclose issues beyond a certain age.
Last edited by mcarans on Fri Apr 03, 2026 9:53 pm, edited 2 times in total.
User avatar
hiran
Theorethicist
Posts: 2656
Joined: Fri Mar 26, 2021 1:39 pm
Location: a parallel world I created for myself. Some call it a singularity...

Re: Streamline development effort : Backlog capture and planning

Post by hiran »

mcarans wrote: Fri Apr 03, 2026 9:46 pm
I don't think it's a good idea to add old issues to the project board. It will just create a lot of noise. I think the original 20 issues are more than enough to occupy the current dev team for years to come so little point in adding things that no one will have any time to look at unless you're putting yourself forward to go through all those old PRs and test them (eg. the FOV one is from 2015 and the code has changed since then).
I cannot even tell if a merge is reasonable, yet test if all would still work with the merge.
Also I do not want to get everything merged blindly, but I'd like to have an educated response on the PRs, even if we reject them. And I will need help on that.

If it works out, we'd be more managing community-provided PRs than developing our own.

From your response we can already say that #130 is no longer applicable. How about closing it with that comment?
Sunshine - Moonlight - Good Times - Oolite
Post Reply