mergedToBeRemoved = new HashSet<>();
35 |
36 | private final Board board;
37 | private final GridOperator gridOperator;
38 | private Animation shakingAnimation;
39 |
40 | public GameManager() {
41 | this(UserSettings.LOCAL.getGridSize());
42 | }
43 |
44 | /**
45 | * GameManager is a Group containing a Board that holds a grid and the score a
46 | * Map holds the location of the tiles in the grid
47 | *
48 | * The purpose of the game is sum the value of the tiles up to 2048 points Based
49 | * on the Javascript version: ...
50 | *
51 | * @param gridSize defines the size of the grid, default 6x6
52 | */
53 | public GameManager(int gridSize) {
54 | this.gameGrid = new HashMap<>();
55 |
56 | gridOperator = new GridOperator(gridSize);
57 | board = new Board(gridOperator);
58 | board.setToolBar(createToolBar());
59 | this.getChildren().add(board);
60 |
61 | var trueProperty = new SimpleBooleanProperty(true);
62 | board.clearGameProperty().and(trueProperty).addListener((ov, b1, b2) -> initializeGameGrid());
63 | board.resetGameProperty().and(trueProperty).addListener((ov, b1, b2) -> startGame());
64 | board.restoreGameProperty().and(trueProperty).addListener((ov, b1, b2) -> doRestoreSession());
65 | board.saveGameProperty().and(trueProperty).addListener((ov, b1, b2) -> doSaveSession());
66 |
67 | initializeGameGrid();
68 | startGame();
69 | }
70 |
71 | /**
72 | * Initializes all cells in gameGrid map to null
73 | */
74 | private void initializeGameGrid() {
75 | gameGrid.clear();
76 | locations.clear();
77 | gridOperator.traverseGrid((x, y) -> {
78 | var location = new Location(x, y);
79 | locations.add(location);
80 | gameGrid.put(location, null);
81 | return 0;
82 | });
83 | }
84 |
85 | /**
86 | * Starts the game by adding 1 or 2 tiles at random locations
87 | */
88 | private void startGame() {
89 | var tile0 = Tile.newRandomTile();
90 | var randomLocs = new ArrayList<>(locations);
91 | Collections.shuffle(randomLocs);
92 | var locs = randomLocs.stream().limit(2).iterator();
93 | tile0.setLocation(locs.next());
94 |
95 | Tile tile1 = null;
96 | if (new Random().nextFloat() <= 0.8) { // gives 80% chance to add a second tile
97 | tile1 = Tile.newRandomTile();
98 | if (tile1.getValue() == 4 && tile0.getValue() == 4) {
99 | tile1 = Tile.newTile(2);
100 | }
101 | tile1.setLocation(locs.next());
102 | }
103 |
104 | Stream.of(tile0, tile1).filter(Objects::nonNull).forEach(t -> gameGrid.put(t.getLocation(), t));
105 |
106 | redrawTilesInGameGrid();
107 |
108 | board.startGame();
109 | }
110 |
111 | /**
112 | * Redraws all tiles in the gameGrid object
113 | */
114 | private void redrawTilesInGameGrid() {
115 | gameGrid.values().stream().filter(Objects::nonNull).forEach(board::addTile);
116 | }
117 |
118 | /**
119 | * Moves the tiles according to given direction At any move, takes care of merge
120 | * tiles, add a new one and perform the required animations It updates the score
121 | * and checks if the user won the game or if the game is over
122 | *
123 | * @param direction is the selected direction to move the tiles
124 | */
125 | private void moveTiles(Direction direction) {
126 | synchronized (gameGrid) {
127 | if (movingTiles) {
128 | return;
129 | }
130 | }
131 |
132 | board.setPoints(0);
133 | mergedToBeRemoved.clear();
134 | var parallelTransition = new ParallelTransition();
135 | gridOperator.sortGrid(direction);
136 | final int tilesWereMoved = gridOperator.traverseGrid((x, y) -> {
137 | var currentLocation = new Location(x, y);
138 | var farthestLocation = findFarthestLocation(currentLocation, direction); // farthest available location
139 | var opTile = optionalTile(currentLocation);
140 |
141 | var result = new AtomicInteger();
142 | var nextLocation = farthestLocation.offset(direction); // calculates to a possible merge
143 |
144 | optionalTile(nextLocation).filter(t -> t.isMergeable(opTile) && !t.isMerged()).ifPresent(t -> {
145 | var tile = opTile.get();
146 | t.merge(tile);
147 | t.toFront();
148 | gameGrid.put(nextLocation, t);
149 | gameGrid.replace(currentLocation, null);
150 |
151 | parallelTransition.getChildren().add(animateExistingTile(tile, t.getLocation()));
152 | parallelTransition.getChildren().add(animateMergedTile(t));
153 | mergedToBeRemoved.add(tile);
154 |
155 | board.addPoints(t.getValue());
156 |
157 | if (t.getValue() == FINAL_VALUE_TO_WIN) {
158 | board.setGameWin(true);
159 | }
160 | result.set(1);
161 | });
162 |
163 | if (result.get() == 0 && opTile.isPresent() && !farthestLocation.equals(currentLocation)) {
164 | var tile = opTile.get();
165 | parallelTransition.getChildren().add(animateExistingTile(tile, farthestLocation));
166 |
167 | gameGrid.put(farthestLocation, tile);
168 | gameGrid.replace(currentLocation, null);
169 |
170 | tile.setLocation(farthestLocation);
171 |
172 | result.set(1);
173 | }
174 |
175 | return result.get();
176 | });
177 |
178 | board.animateScore();
179 | if (parallelTransition.getChildren().size() > 0) {
180 | parallelTransition.setOnFinished(e -> {
181 | board.removeTiles(mergedToBeRemoved);
182 | // reset merged after each movement
183 | gameGrid.values().stream().filter(Objects::nonNull).forEach(Tile::clearMerge);
184 |
185 | var randomAvailableLocation = findRandomAvailableLocation();
186 | if (randomAvailableLocation.isEmpty() && mergeMovementsAvailable() == 0) {
187 | // game is over if there are no more moves available
188 | board.setGameOver(true);
189 | } else if (randomAvailableLocation.isPresent() && tilesWereMoved > 0) {
190 | synchronized (gameGrid) {
191 | movingTiles = false;
192 | }
193 | addAndAnimateRandomTile(randomAvailableLocation.get());
194 | }
195 | });
196 |
197 | synchronized (gameGrid) {
198 | movingTiles = true;
199 | }
200 |
201 | parallelTransition.play();
202 | }
203 |
204 | if (tilesWereMoved == 0) {
205 | // no tiles got moved
206 | // shake the game pane
207 | if (shakingAnimation == null) {
208 | shakingAnimation = createShakeGamePaneAnimation();
209 | }
210 |
211 | if (!shakingAnimationPlaying) {
212 | shakingAnimation.play();
213 | shakingAnimationPlaying = true;
214 | }
215 | }
216 | }
217 |
218 | private boolean shakingAnimationPlaying = false;
219 | private boolean shakingXYState = false;
220 |
221 | /**
222 | * optionalTile allows using tiles from the map at some location, whether they
223 | * are null or not
224 | *
225 | * @param loc location of the tile
226 | * @return an Optional containing null or a valid tile
227 | */
228 | private Optional optionalTile(Location loc) {
229 | return Optional.ofNullable(gameGrid.get(loc));
230 | }
231 |
232 | /**
233 | * Searches for the farthest empty location where the current tile could go
234 | *
235 | * @param location of the tile
236 | * @param direction of movement
237 | * @return a location
238 | */
239 | private Location findFarthestLocation(Location location, Direction direction) {
240 | Location farthest;
241 |
242 | do {
243 | farthest = location;
244 | location = farthest.offset(direction);
245 | } while (gridOperator.isValidLocation(location) && optionalTile(location).isEmpty());
246 |
247 | return farthest;
248 | }
249 |
250 | /**
251 | * Finds the number of pairs of tiles that can be merged
252 | *
253 | * This method is called only when the grid is full of tiles, what makes the use
254 | * of Optional unnecessary, but it could be used when the board is not full to
255 | * find the number of pairs of merge-able tiles and provide a hint for the user,
256 | * for instance
257 | *
258 | * @return the number of pairs of tiles that can be merged
259 | */
260 | private int mergeMovementsAvailable() {
261 | final var pairsOfMergeableTiles = new AtomicInteger();
262 |
263 | Stream.of(Direction.UP, Direction.LEFT).parallel().forEach(direction -> gridOperator.traverseGrid((x, y) -> {
264 | var thisLocation = new Location(x, y);
265 | optionalTile(thisLocation).ifPresent(t -> {
266 | if (t.isMergeable(optionalTile(thisLocation.offset(direction)))) {
267 | pairsOfMergeableTiles.incrementAndGet();
268 | }
269 | });
270 | return 0;
271 | }));
272 | return pairsOfMergeableTiles.get();
273 | }
274 |
275 | /**
276 | * Finds a random location or returns null if none exist
277 | *
278 | * @return a random location or null if there are no more locations
279 | * available
280 | */
281 | private Optional findRandomAvailableLocation() {
282 | var availableLocations = locations.stream().filter(l -> gameGrid.get(l) == null).collect(Collectors.toList());
283 |
284 | if (availableLocations.isEmpty()) {
285 | return Optional.empty();
286 | }
287 |
288 | Collections.shuffle(availableLocations);
289 |
290 | // returns a random location
291 | return Optional.of(availableLocations.get(new Random().nextInt(availableLocations.size())));
292 | }
293 |
294 | /**
295 | * Adds a tile of random value to a random location with a proper animation
296 | *
297 | */
298 | private void addAndAnimateRandomTile(Location randomLocation) {
299 | var tile = board.addRandomTile(randomLocation);
300 | gameGrid.put(tile.getLocation(), tile);
301 |
302 | animateNewlyAddedTile(tile).play();
303 | }
304 |
305 | /**
306 | * Animation that creates a fade in effect when a tile is added to the game by
307 | * increasing the tile scale from 0 to 100%
308 | *
309 | * @param tile to be animated
310 | * @return a scale transition
311 | */
312 | private ScaleTransition animateNewlyAddedTile(Tile tile) {
313 | final var scaleTransition = new ScaleTransition(ANIMATION_NEWLY_ADDED_TILE, tile);
314 | scaleTransition.setToX(1.0);
315 | scaleTransition.setToY(1.0);
316 | scaleTransition.setInterpolator(Interpolator.EASE_OUT);
317 | scaleTransition.setOnFinished(e -> {
318 | // after last movement on full grid, check if there are movements available
319 | if (this.gameGrid.values().parallelStream().noneMatch(Objects::isNull) && mergeMovementsAvailable() == 0) {
320 | board.setGameOver(true);
321 | }
322 | });
323 | return scaleTransition;
324 | }
325 |
326 | private Animation createShakeGamePaneAnimation() {
327 | var shakingAnimation = new Timeline(new KeyFrame(Duration.seconds(0.05), (ae) -> {
328 | var parent = getParent();
329 |
330 | if (shakingXYState) {
331 | parent.setLayoutX(parent.getLayoutX() + 5);
332 | parent.setLayoutY(parent.getLayoutY() + 5);
333 | } else {
334 | parent.setLayoutX(parent.getLayoutX() - 5);
335 | parent.setLayoutY(parent.getLayoutY() - 5);
336 | }
337 |
338 | shakingXYState = !shakingXYState;
339 | }));
340 |
341 | shakingAnimation.setCycleCount(6);
342 | shakingAnimation.setAutoReverse(false);
343 | shakingAnimation.setOnFinished(event -> {
344 | shakingXYState = false;
345 | shakingAnimationPlaying = false;
346 | });
347 |
348 | return shakingAnimation;
349 | }
350 |
351 | /**
352 | * Animation that moves the tile from its previous location to a new location
353 | *
354 | * @param tile to be animated
355 | * @param newLocation new location of the tile
356 | * @return a timeline
357 | */
358 | private Timeline animateExistingTile(Tile tile, Location newLocation) {
359 | var timeline = new Timeline();
360 | var kvX = new KeyValue(tile.layoutXProperty(),
361 | newLocation.getLayoutX(Board.CELL_SIZE) - (tile.getMinHeight() / 2), Interpolator.EASE_OUT);
362 | var kvY = new KeyValue(tile.layoutYProperty(),
363 | newLocation.getLayoutY(Board.CELL_SIZE) - (tile.getMinHeight() / 2), Interpolator.EASE_OUT);
364 |
365 | var kfX = new KeyFrame(ANIMATION_EXISTING_TILE, kvX);
366 | var kfY = new KeyFrame(ANIMATION_EXISTING_TILE, kvY);
367 |
368 | timeline.getKeyFrames().add(kfX);
369 | timeline.getKeyFrames().add(kfY);
370 |
371 | return timeline;
372 | }
373 |
374 | /**
375 | * Animation that creates a pop effect when two tiles merge by increasing the
376 | * tile scale to 120% at the middle, and then going back to 100%
377 | *
378 | * @param tile to be animated
379 | * @return a sequential transition
380 | */
381 | private SequentialTransition animateMergedTile(Tile tile) {
382 | final var scale0 = new ScaleTransition(ANIMATION_MERGED_TILE, tile);
383 | scale0.setToX(1.2);
384 | scale0.setToY(1.2);
385 | scale0.setInterpolator(Interpolator.EASE_IN);
386 |
387 | final var scale1 = new ScaleTransition(ANIMATION_MERGED_TILE, tile);
388 | scale1.setToX(1.0);
389 | scale1.setToY(1.0);
390 | scale1.setInterpolator(Interpolator.EASE_OUT);
391 |
392 | return new SequentialTransition(scale0, scale1);
393 | }
394 |
395 | /**
396 | * Move the tiles according user input if overlay is not on
397 | *
398 | */
399 | public void move(Direction direction) {
400 | if (!board.isLayerOn().get()) {
401 | moveTiles(direction);
402 | }
403 | }
404 |
405 | /**
406 | * Set gameManager scale to adjust overall game size
407 | *
408 | */
409 | public void setScale(double scale) {
410 | this.setScaleX(scale);
411 | this.setScaleY(scale);
412 | }
413 |
414 | /**
415 | * Pauses the game time, covers the grid
416 | */
417 | public void pauseGame() {
418 | board.pauseGame();
419 | }
420 |
421 | /**
422 | * Quit the game with confirmation
423 | */
424 | public void quitGame() {
425 | board.quitGame();
426 | }
427 |
428 | /**
429 | * Ask to save the game from a properties file with confirmation
430 | */
431 | public void saveSession() {
432 | board.saveSession();
433 | }
434 |
435 | /**
436 | * Save the game to a properties file, without confirmation
437 | */
438 | private void doSaveSession() {
439 | board.saveSession(gameGrid);
440 | }
441 |
442 | /**
443 | * Ask to restore the game from a properties file with confirmation
444 | */
445 | public void restoreSession() {
446 | board.restoreSession();
447 | }
448 |
449 | /**
450 | * Restore the game from a properties file, without confirmation
451 | */
452 | private void doRestoreSession() {
453 | initializeGameGrid();
454 | if (board.restoreSession(gameGrid)) {
455 | redrawTilesInGameGrid();
456 | }
457 | }
458 |
459 | /**
460 | * Save actual record to a properties file
461 | */
462 | public void saveRecord() {
463 | board.saveRecord();
464 | }
465 |
466 | private HBox createToolBar() {
467 | var btItem1 = createButtonItem("mSave", "Save Session", t -> saveSession());
468 | var btItem2 = createButtonItem("mRestore", "Restore Session", t -> restoreSession());
469 | var btItem3 = createButtonItem("mPause", "Pause Game", t -> board.pauseGame());
470 | var btItem4 = createButtonItem("mReplay", "Try Again", t -> board.showTryAgainOverlay());
471 | var btItem5 = createButtonItem("mInfo", "About the Game", t -> board.aboutGame());
472 | var btItem6 = createButtonItem("mQuit", "Quit Game", t -> quitGame());
473 |
474 | var toolbar = new HBox(btItem1, btItem2, btItem3, btItem4, btItem5, btItem6);
475 | toolbar.setAlignment(Pos.CENTER);
476 | toolbar.setPadding(new Insets(10.0));
477 | return toolbar;
478 | }
479 |
480 | private Button createButtonItem(String symbol, String text, EventHandler t) {
481 | var g = new Button();
482 | g.setPrefSize(40, 40);
483 | g.setId(symbol);
484 | g.setOnAction(t);
485 | g.setTooltip(new Tooltip(text));
486 | return g;
487 | }
488 |
489 | }
490 |
--------------------------------------------------------------------------------
/src/main/java/io/fxgame/game2048/Board.java:
--------------------------------------------------------------------------------
1 | package io.fxgame.game2048;
2 |
3 | import java.time.LocalTime;
4 | import java.time.ZoneId;
5 | import java.time.format.DateTimeFormatter;
6 | import java.util.Map;
7 | import java.util.Set;
8 |
9 | import javafx.animation.Animation;
10 | import javafx.animation.KeyFrame;
11 | import javafx.animation.KeyValue;
12 | import javafx.animation.Timeline;
13 | import javafx.application.Platform;
14 | import javafx.beans.binding.Bindings;
15 | import javafx.beans.property.BooleanProperty;
16 | import javafx.beans.property.SimpleStringProperty;
17 | import javafx.beans.property.StringProperty;
18 | import javafx.beans.value.ChangeListener;
19 | import javafx.beans.value.ObservableValue;
20 | import javafx.geometry.Insets;
21 | import javafx.geometry.Pos;
22 | import javafx.scene.Group;
23 | import javafx.scene.control.Button;
24 | import javafx.scene.control.Hyperlink;
25 | import javafx.scene.control.Label;
26 | import javafx.scene.layout.HBox;
27 | import javafx.scene.layout.Pane;
28 | import javafx.scene.layout.Priority;
29 | import javafx.scene.layout.VBox;
30 | import javafx.scene.paint.Color;
31 | import javafx.scene.shape.Rectangle;
32 | import javafx.scene.text.Text;
33 | import javafx.scene.text.TextAlignment;
34 | import javafx.scene.text.TextFlow;
35 | import javafx.util.Duration;
36 |
37 | /**
38 | * @author Narendra Yusuf
39 | */
40 | public class Board extends Pane {
41 |
42 | public static final int CELL_SIZE = 128;
43 | private static final int BORDER_WIDTH = (14 + 2) / 2;
44 | private static final int TOP_HEIGHT = 92;
45 | private static final int GAP_HEIGHT = 50;
46 | private static final int TOOLBAR_HEIGHT = 80;
47 |
48 | private final GameState state = new GameState();
49 |
50 | private LocalTime time;
51 | private Timeline timer;
52 | private final StringProperty clock = new SimpleStringProperty("00:00:00");
53 | private final DateTimeFormatter fmt = DateTimeFormatter.ofPattern("HH:mm:ss").withZone(ZoneId.systemDefault());
54 |
55 | // User Interface controls
56 | private final VBox vGame = new VBox(0);
57 | private final Group gridGroup = new Group();
58 |
59 | private final HBox hTop = new HBox(0);
60 | private final VBox vScore = new VBox(-5);
61 | private final Label lblScore = new Label("0");
62 | private final Label lblBest = new Label("0");
63 | private final Label lblPoints = new Label();
64 |
65 | private final HBox overlay = new HBox();
66 | private final VBox txtOverlay = new VBox(10);
67 | private final Label lOvrText = new Label();
68 | private final Label lOvrSubText = new Label();
69 | private final HBox buttonsOverlay = new HBox();
70 |
71 | // Overlay Buttons
72 | private final Button bTry = new Button("Try again");
73 | private final Button bContinue = new Button("Keep going");
74 | private final Button bContinueNo = new Button("No, keep going");
75 | private final Button bSave = new Button("Save");
76 | private final Button bRestore = new Button("Restore");
77 | private final Button bQuit = new Button("Quit");
78 |
79 | private final HBox hToolbar = new HBox();
80 |
81 | private final Label lblTime = new Label();
82 |
83 | private final int gridDimension;
84 | private final GridOperator gridOperator;
85 | private final SessionManager sessionManager;
86 |
87 | public Board(GridOperator grid) {
88 | this.gridOperator = grid;
89 | gridDimension = CELL_SIZE * grid.getGridSize() + BORDER_WIDTH * 2;
90 | sessionManager = new SessionManager(gridOperator);
91 |
92 | createScore();
93 | createGrid();
94 | createToolBar();
95 | initGameProperties();
96 | }
97 |
98 | private void createScore() {
99 | var lblTitle = new Label("2048");
100 | lblTitle.getStyleClass().addAll("game-label", "game-title");
101 |
102 | var lblSubtitle = new Label("FX");
103 | lblSubtitle.getStyleClass().addAll("game-label", "game-subtitle");
104 |
105 | var hFill = new HBox();
106 | HBox.setHgrow(hFill, Priority.ALWAYS);
107 | hFill.setAlignment(Pos.CENTER);
108 |
109 | var vScores = new VBox();
110 | var hScores = new HBox(5);
111 |
112 | vScore.setAlignment(Pos.CENTER);
113 | vScore.getStyleClass().add("game-vbox");
114 |
115 | var lblTit = new Label("SCORE");
116 | lblTit.getStyleClass().addAll("game-label", "game-titScore");
117 |
118 | lblScore.getStyleClass().addAll("game-label", "game-score");
119 | lblScore.textProperty().bind(state.gameScoreProperty.asString());
120 | vScore.getChildren().addAll(lblTit, lblScore);
121 |
122 | var vRecord = new VBox(-5);
123 | vRecord.setAlignment(Pos.CENTER);
124 | vRecord.getStyleClass().add("game-vbox");
125 |
126 | var lblTitBest = new Label("BEST");
127 | lblTitBest.getStyleClass().addAll("game-label", "game-titScore");
128 | lblBest.getStyleClass().addAll("game-label", "game-score");
129 | lblBest.textProperty().bind(state.gameBestProperty.asString());
130 | vRecord.getChildren().addAll(lblTitBest, lblBest);
131 | hScores.getChildren().addAll(vScore, vRecord);
132 |
133 | var vFill = new VBox();
134 | VBox.setVgrow(vFill, Priority.ALWAYS);
135 | vScores.getChildren().addAll(hScores, vFill);
136 |
137 | hTop.getChildren().addAll(lblTitle, lblSubtitle, hFill, vScores);
138 | hTop.setMinSize(gridDimension, TOP_HEIGHT);
139 | hTop.setPrefSize(gridDimension, TOP_HEIGHT);
140 | hTop.setMaxSize(gridDimension, TOP_HEIGHT);
141 |
142 | vGame.getChildren().add(hTop);
143 |
144 | var hTime = new HBox();
145 | hTime.setMinSize(gridDimension, GAP_HEIGHT);
146 | hTime.setAlignment(Pos.BOTTOM_RIGHT);
147 | lblTime.getStyleClass().addAll("game-label", "game-time");
148 | lblTime.textProperty().bind(clock);
149 | timer = new Timeline(new KeyFrame(Duration.ZERO, e -> clock.set(LocalTime.now().minusNanos(time.toNanoOfDay()).format(fmt))), new KeyFrame(Duration.seconds(1)));
150 | timer.setCycleCount(Animation.INDEFINITE);
151 | hTime.getChildren().add(lblTime);
152 |
153 | vGame.getChildren().add(hTime);
154 | getChildren().add(vGame);
155 |
156 | lblPoints.getStyleClass().addAll("game-label", "game-points");
157 | lblPoints.setAlignment(Pos.CENTER);
158 | lblPoints.setMinWidth(100);
159 | getChildren().add(lblPoints);
160 | }
161 |
162 | private Rectangle createCell(int i, int j) {
163 | final double arcSize = CELL_SIZE / 6d;
164 | var cell = new Rectangle(i * CELL_SIZE, j * CELL_SIZE, CELL_SIZE, CELL_SIZE);
165 | // provide default style in case css are not loaded
166 | cell.setFill(Color.WHITE);
167 | cell.setStroke(Color.GREY);
168 | cell.setArcHeight(arcSize);
169 | cell.setArcWidth(arcSize);
170 | cell.getStyleClass().add("game-grid-cell");
171 | return cell;
172 | }
173 |
174 | private void createGrid() {
175 | gridOperator.traverseGrid((i, j) -> {
176 | gridGroup.getChildren().add(createCell(i, j));
177 | return 0;
178 | });
179 |
180 | gridGroup.getStyleClass().add("game-grid");
181 | gridGroup.setManaged(false);
182 | gridGroup.setLayoutX(BORDER_WIDTH);
183 | gridGroup.setLayoutY(BORDER_WIDTH);
184 |
185 | var hBottom = new HBox();
186 | hBottom.getStyleClass().add("game-backGrid");
187 | hBottom.setMinSize(gridDimension, gridDimension);
188 | hBottom.setPrefSize(gridDimension, gridDimension);
189 | hBottom.setMaxSize(gridDimension, gridDimension);
190 |
191 | // Clip hBottom to keep the drop-shadow effects within the hBottom
192 | var rect = new Rectangle(gridDimension, gridDimension);
193 | hBottom.setClip(rect);
194 | hBottom.getChildren().add(gridGroup);
195 |
196 | vGame.getChildren().add(hBottom);
197 | }
198 |
199 | private void createToolBar() {
200 | // toolbar
201 | var hPadding = new HBox();
202 | hPadding.setMinSize(gridDimension, TOOLBAR_HEIGHT);
203 | hPadding.setPrefSize(gridDimension, TOOLBAR_HEIGHT);
204 | hPadding.setMaxSize(gridDimension, TOOLBAR_HEIGHT);
205 |
206 | hToolbar.setAlignment(Pos.CENTER);
207 | hToolbar.getStyleClass().add("game-backGrid");
208 | hToolbar.setMinSize(gridDimension, TOOLBAR_HEIGHT);
209 | hToolbar.setPrefSize(gridDimension, TOOLBAR_HEIGHT);
210 | hToolbar.setMaxSize(gridDimension, TOOLBAR_HEIGHT);
211 |
212 | vGame.getChildren().add(hPadding);
213 | vGame.getChildren().add(hToolbar);
214 | }
215 |
216 | protected void setToolBar(HBox toolbar) {
217 | toolbar.disableProperty().bind(state.layerOnProperty);
218 | toolbar.spacingProperty().bind(Bindings.divide(vGame.widthProperty(), 10));
219 | hToolbar.getChildren().add(toolbar);
220 | }
221 |
222 | protected void showTryAgainOverlay() {
223 | if (!state.gameTryAgainProperty.get()) {
224 | state.gameTryAgainProperty.set(true);
225 | }
226 | }
227 |
228 | private void tryAgain() {
229 | state.layerOnProperty.set(false);
230 | doResetGame();
231 | }
232 |
233 | private void keepGoing() {
234 | state.keepGoing();
235 | timer.play();
236 | }
237 |
238 | private void exitGame() {
239 | Platform.exit();
240 | }
241 |
242 | private final Overlay wonListener = new Overlay("You win!", "", bContinue, bTry, "game-overlay-won", "game-lblWon");
243 |
244 | private class Overlay implements ChangeListener {
245 |
246 | private final Button leftButton, rightButton;
247 | private final String message, warning;
248 | private final String style1, style2;
249 |
250 | public Overlay(String message, String warning, Button leftButton, Button rightButton, String style1, String style2) {
251 | this.message = message;
252 | this.warning = warning;
253 | this.leftButton = leftButton;
254 | this.rightButton = rightButton;
255 | this.style1 = style1;
256 | this.style2 = style2;
257 | }
258 |
259 | @Override
260 | public void changed(ObservableValue observable, Boolean oldValue, Boolean newValue) {
261 | if (!newValue) {
262 | return;
263 | }
264 |
265 | timer.stop();
266 |
267 | overlay.getStyleClass().setAll("game-overlay", style1);
268 | lOvrText.setText(message);
269 | lOvrText.getStyleClass().setAll("game-label", style2);
270 | lOvrSubText.setText(warning);
271 | lOvrSubText.getStyleClass().setAll("game-label", "game-lblWarning");
272 | txtOverlay.getChildren().setAll(lOvrText, lOvrSubText);
273 | buttonsOverlay.getChildren().setAll(leftButton);
274 |
275 | if (rightButton != null) {
276 | buttonsOverlay.getChildren().add(rightButton);
277 | }
278 |
279 | if (!state.layerOnProperty.get()) {
280 | var defaultBtn = rightButton == null ? leftButton : rightButton;
281 | defaultBtn.requestFocus();
282 | defaultBtn.setDefaultButton(true);
283 |
284 | Board.this.getChildren().addAll(overlay, buttonsOverlay);
285 | state.layerOnProperty.set(true);
286 | }
287 | }
288 | }
289 |
290 | private void initGameProperties() {
291 | overlay.setMinSize(gridDimension, gridDimension);
292 | overlay.setAlignment(Pos.CENTER);
293 | overlay.setTranslateY(TOP_HEIGHT + GAP_HEIGHT);
294 |
295 | overlay.getChildren().setAll(txtOverlay);
296 | txtOverlay.setAlignment(Pos.CENTER);
297 |
298 | buttonsOverlay.setAlignment(Pos.CENTER);
299 | buttonsOverlay.setTranslateY(TOP_HEIGHT + GAP_HEIGHT + (double) gridDimension / 2);
300 | buttonsOverlay.setMinSize(gridDimension, (double) gridDimension / 2);
301 | buttonsOverlay.setSpacing(10);
302 |
303 | bTry.getStyleClass().add("game-button");
304 | bTry.setOnAction(e -> tryAgain());
305 |
306 | bContinue.getStyleClass().add("game-button");
307 | bContinue.setOnAction(e -> keepGoing());
308 |
309 | bContinueNo.getStyleClass().add("game-button");
310 | bContinueNo.setOnAction(e -> keepGoing());
311 |
312 | bSave.getStyleClass().add("game-button");
313 | bSave.setOnAction(e -> state.saveGame.set(true));
314 |
315 | bRestore.getStyleClass().add("game-button");
316 | bRestore.setOnAction(e -> state.restoreGame.set(true));
317 |
318 | bQuit.getStyleClass().add("game-button");
319 | bQuit.setOnAction(e -> exitGame());
320 |
321 | state.gameWonProperty.addListener(wonListener);
322 | state.gameOverProperty
323 | .addListener(new Overlay("Game over!", "", bTry, null, "game-overlay-over", "game-lblOver"));
324 | state.gamePauseProperty.addListener(
325 | new Overlay("Game Paused", "", bContinue, null, "game-overlay-pause", "game-lblPause"));
326 | state.gameTryAgainProperty.addListener(new Overlay("Try Again?", "Current game will be deleted", bTry, bContinueNo,
327 | "game-overlay-pause", "game-lblPause"));
328 | state.gameSaveProperty.addListener(new Overlay("Save?", "Previous saved data will be overwritten", bSave, bContinueNo,
329 | "game-overlay-pause", "game-lblPause"));
330 | state.gameRestoreProperty.addListener(new Overlay("Restore?", "Current game will be deleted", bRestore, bContinueNo,
331 | "game-overlay-pause", "game-lblPause"));
332 | state.gameAboutProperty.addListener((observable, oldValue, newValue) -> {
333 | if (newValue) {
334 | timer.stop();
335 | overlay.getStyleClass().setAll("game-overlay", "game-overlay-quit");
336 |
337 | var flow = new TextFlow();
338 | flow.setTextAlignment(TextAlignment.CENTER);
339 | flow.setPadding(new Insets(10, 0, 0, 0));
340 | flow.setMinSize(gridDimension, gridDimension);
341 | flow.setPrefSize(gridDimension, gridDimension);
342 | flow.setMaxSize(gridDimension, gridDimension);
343 | flow.setPrefSize(Double.NEGATIVE_INFINITY, Double.NEGATIVE_INFINITY);
344 |
345 | var t00 = new Text("2048");
346 | t00.getStyleClass().setAll("game-label", "game-lblAbout");
347 |
348 | var t01 = new Text("FX");
349 | t01.getStyleClass().setAll("game-label", "game-lblAbout2");
350 |
351 | var t02 = new Text(" Game\n");
352 | t02.getStyleClass().setAll("game-label", "game-lblAbout");
353 |
354 | var t1 = new Text("JavaFX game - Desktop version\n\n");
355 | t1.getStyleClass().setAll("game-label", "game-lblAboutSub");
356 |
357 | var t20 = new Text("Powered by ");
358 | t20.getStyleClass().setAll("game-label", "game-lblAboutSub");
359 |
360 | var link1 = new Hyperlink();
361 | link1.setText("OpenJFX");
362 | link1.setOnAction(e -> Game2048.urlOpener().open("https://openjfx.io/"));
363 | link1.getStyleClass().setAll("game-label", "game-lblAboutSub2");
364 |
365 | var t21 = new Text(" Project \n\n");
366 | t21.getStyleClass().setAll("game-label", "game-lblAboutSub");
367 |
368 | var t23 = new Text("© ");
369 | t23.getStyleClass().setAll("game-label", "game-lblAboutSub");
370 |
371 | var link2 = new Hyperlink();
372 | link2.setText("@Narendraysf");
373 | link2.setOnAction(e -> Game2048.urlOpener().open("https://narendra-blog.netlify.app/"));
374 | link2.getStyleClass().setAll("game-label", "game-lblAboutSub2");
375 |
376 |
377 | flow.getChildren().setAll(t00, t01, t02, t1, t20, link1, t21, t23, link2);
378 | txtOverlay.getChildren().setAll(flow);
379 | buttonsOverlay.getChildren().setAll(bContinue);
380 | this.getChildren().removeAll(overlay, buttonsOverlay);
381 | this.getChildren().addAll(overlay, buttonsOverlay);
382 | state.layerOnProperty.set(true);
383 | }
384 | });
385 | state.gameQuitProperty.addListener(new Overlay("Quit Game?", "Non saved data will be lost", bQuit, bContinueNo,
386 | "game-overlay-quit", "game-lblQuit"));
387 |
388 | restoreRecord();
389 |
390 | state.gameScoreProperty.addListener((ov, i, i1) -> {
391 | if (i1.intValue() > state.gameBestProperty.get()) {
392 | state.gameBestProperty.set(i1.intValue());
393 | }
394 | });
395 |
396 | state.layerOnProperty.addListener((ov, b, b1) -> {
397 | if (!b1) {
398 | getChildren().removeAll(overlay, buttonsOverlay);
399 | // Keep the focus on the game when the layer is removed:
400 | getParent().requestFocus();
401 | } else {
402 | // Set focus on the first button
403 | buttonsOverlay.getChildren().get(0).requestFocus();
404 | }
405 | });
406 |
407 | }
408 |
409 | private void doResetGame() {
410 | doClearGame();
411 | state.resetGame();
412 | }
413 |
414 | private void doClearGame() {
415 | saveRecord();
416 | gridGroup.getChildren().removeIf(c -> c instanceof Tile);
417 | getChildren().removeAll(overlay, buttonsOverlay);
418 |
419 | state.clearState();
420 | }
421 |
422 | public void animateScore() {
423 | if (state.gameMovePoints.get() == 0) {
424 | return;
425 | }
426 |
427 | final var timeline = new Timeline();
428 | lblPoints.setText("+" + state.gameMovePoints.getValue().toString());
429 | lblPoints.setOpacity(1);
430 |
431 | double posX = vScore.localToScene(vScore.getWidth() / 2d, 0).getX();
432 | lblPoints.setTranslateX(0);
433 | lblPoints.setTranslateX(lblPoints.sceneToLocal(posX, 0).getX() - lblPoints.getWidth() / 2d);
434 | lblPoints.setLayoutY(20);
435 |
436 | final var kvO = new KeyValue(lblPoints.opacityProperty(), 0);
437 | final var kvY = new KeyValue(lblPoints.layoutYProperty(), 100);
438 |
439 | var animationDuration = Duration.millis(600);
440 | final KeyFrame kfO = new KeyFrame(animationDuration, kvO);
441 | final KeyFrame kfY = new KeyFrame(animationDuration, kvY);
442 |
443 | timeline.getKeyFrames().add(kfO);
444 | timeline.getKeyFrames().add(kfY);
445 |
446 | timeline.play();
447 | }
448 |
449 | public void addTile(Tile tile) {
450 | double layoutX = tile.getLocation().getLayoutX(CELL_SIZE) - (tile.getMinWidth() / 2);
451 | double layoutY = tile.getLocation().getLayoutY(CELL_SIZE) - (tile.getMinHeight() / 2);
452 |
453 | tile.setLayoutX(layoutX);
454 | tile.setLayoutY(layoutY);
455 | gridGroup.getChildren().add(tile);
456 | }
457 |
458 | public Tile addRandomTile(Location randomLocation) {
459 | var tile = Tile.newRandomTile();
460 | tile.setLocation(randomLocation);
461 |
462 | double layoutX = tile.getLocation().getLayoutX(CELL_SIZE) - (tile.getMinWidth() / 2);
463 | double layoutY = tile.getLocation().getLayoutY(CELL_SIZE) - (tile.getMinHeight() / 2);
464 |
465 | tile.setLayoutX(layoutX);
466 | tile.setLayoutY(layoutY);
467 | tile.setScaleX(0);
468 | tile.setScaleY(0);
469 |
470 | gridGroup.getChildren().add(tile);
471 |
472 | return tile;
473 | }
474 |
475 | public void startGame() {
476 | restoreRecord();
477 |
478 | time = LocalTime.now();
479 | timer.playFromStart();
480 | }
481 |
482 | public void setPoints(int points) {
483 | state.gameMovePoints.set(points);
484 | }
485 |
486 | public void addPoints(int points) {
487 | state.gameMovePoints.set(state.gameMovePoints.get() + points);
488 | state.gameScoreProperty.set(state.gameScoreProperty.get() + points);
489 | }
490 |
491 | public void setGameOver(boolean gameOver) {
492 | state.gameOverProperty.set(gameOver);
493 | }
494 |
495 | public void setGameWin(boolean won) {
496 | if (!state.gameWonProperty.get()) {
497 | state.gameWonProperty.set(won);
498 | }
499 | }
500 |
501 | public void pauseGame() {
502 | if (!state.gamePauseProperty.get()) {
503 | state.gamePauseProperty.set(true);
504 | }
505 | }
506 |
507 | public void aboutGame() {
508 | if (!state.gameAboutProperty.get()) {
509 | state.gameAboutProperty.set(true);
510 | }
511 | }
512 |
513 | public void quitGame() {
514 | if (state.gameQuitProperty.get()) {
515 | exitGame();
516 | } else {
517 | state.gameQuitProperty.set(true);
518 | }
519 | }
520 |
521 | protected BooleanProperty isLayerOn() {
522 | return state.layerOnProperty;
523 | }
524 |
525 | protected BooleanProperty resetGameProperty() {
526 | return state.resetGame;
527 | }
528 |
529 | protected BooleanProperty clearGameProperty() {
530 | return state.clearGame;
531 | }
532 |
533 | protected BooleanProperty saveGameProperty() {
534 | return state.saveGame;
535 | }
536 |
537 | protected BooleanProperty restoreGameProperty() {
538 | return state.restoreGame;
539 | }
540 |
541 | public void saveSession() {
542 | if (!state.gameSaveProperty.get()) {
543 | state.gameSaveProperty.set(true);
544 | }
545 | }
546 |
547 | /*
548 | * Once we have confirmation
549 | */
550 | public void saveSession(Map gameGrid) {
551 | state.saveGame.set(false);
552 | sessionManager.saveSession(gameGrid, state.gameScoreProperty.getValue(),
553 | LocalTime.now().minusNanos(time.toNanoOfDay()).toNanoOfDay());
554 | keepGoing();
555 | }
556 |
557 | public void restoreSession() {
558 | if (!state.gameRestoreProperty.get()) {
559 | state.gameRestoreProperty.set(true);
560 | }
561 | }
562 |
563 | /*
564 | * Once we have confirmation
565 | */
566 | public boolean restoreSession(Map gameGrid) {
567 | state.restoreGame.set(false);
568 | doClearGame();
569 | timer.stop();
570 | var sTime = new SimpleStringProperty("");
571 | int score = sessionManager.restoreSession(gameGrid, sTime);
572 | if (score >= 0) {
573 | state.gameScoreProperty.set(score);
574 | // check tiles>=2048
575 | state.gameWonProperty.set(false);
576 | gameGrid.forEach((l, t) -> {
577 | if (t != null && t.getValue() >= GameManager.FINAL_VALUE_TO_WIN) {
578 | state.gameWonProperty.removeListener(wonListener);
579 | state.gameWonProperty.set(true);
580 | state.gameWonProperty.addListener(wonListener);
581 | }
582 | });
583 | if (!sTime.get().isEmpty()) {
584 | time = LocalTime.now().minusNanos(Long.parseLong(sTime.get()));
585 | }
586 | timer.play();
587 | return true;
588 | }
589 | // not session found, restart again
590 | doResetGame();
591 | return false;
592 | }
593 |
594 | public void saveRecord() {
595 | var recordManager = new RecordManager(gridOperator.getGridSize());
596 | recordManager.saveRecord(state.gameScoreProperty.getValue());
597 | }
598 |
599 | private void restoreRecord() {
600 | var recordManager = new RecordManager(gridOperator.getGridSize());
601 | state.gameBestProperty.set(recordManager.restoreRecord());
602 | }
603 |
604 | public void removeTiles(Set mergedToBeRemoved) {
605 | gridGroup.getChildren().removeAll(mergedToBeRemoved);
606 | }
607 |
608 | }
609 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | {project} Copyright (C) {year} {fullname}
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
--------------------------------------------------------------------------------